Skip to content

Commit

Permalink
docs: add Spacelift documentation (#313)
Browse files Browse the repository at this point in the history
  • Loading branch information
mtweeman authored Nov 23, 2024
1 parent 744e9e3 commit f588282
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ General overview of the repository structure. Not all files/directories are list
├── .github # GitHub config files
│ ├── workflows # GitHub Actions config files
│ └── renovate.json # Renovate config
├── .spacelift # Spacelift config files
│ └── workflow.yml # Spacelift workflow tool config file
├── certificates # Certificates
├── components # Terraform root modules
├── machine-images # Source files for machine images
Expand Down Expand Up @@ -78,7 +80,7 @@ Following CLI tools are contained within the image:

### Dependency updates

[Renovate](https://docs.renovatebot.com/) is used as a tool for automated dependency updates. Although it handles many dependencies out of the box, there are many that are not supported yet. These have to be taken care of separately via [config file](.github/renovate.json). Verify periodically all dependencies against Renovate latest documentation/config file, to see if dependency support is added/separate handling is still needed.
[Renovate](https://docs.renovatebot.com/) is used as a tool for automated dependency updates. Although it handles many dependencies out of the box, there are many that are not supported yet. These have to be taken care of separately via [config file](.github/renovate.json). Verify periodically all dependencies against Renovate latest documentation/config file, to see if dependency support is added/separate handling is still needed. See [Renovate console](https://developer.mend.io/github/hajle-silesia/provisioning) for scanning details.

### Static analysis

Expand All @@ -100,6 +102,15 @@ Following static analysis tools are contained within the image with pre-commit h
| [TFLint](https://github.com/terraform-linters/tflint) | Linter |
| [Trivy](https://github.com/aquasecurity/trivy) | Security vulnerabilities check |

### Deployment

[Spacelift](https://spacelift.io/) is used as a tool for orchestration of infrastructure provisioning. It's configured to work with Atmos as described [here](https://docs.cloudposse.com/layers/spacelift/). See [Spacelift console](https://hajle-silesia.app.spacelift.io/) for configuration details. [Custom workflow tool](https://docs.spacelift.io/vendors/terraform/workflow-tool) is defined [here](.spacelift/workflow.yml) due to Terraform FOSS version constraints.
Additional information:
- [Spacelift components](https://docs.cloudposse.com/components/library/aws/spacelift/)
- [Spacelift admin stack component](https://github.com/cloudposse-terraform-components/aws-spacelift-admin-stack)
- [Spacelift spaces component](https://github.com/cloudposse-terraform-components/aws-spacelift-spaces)
- [Spacelift as TACOS](https://docs.cloudposse.com/layers/spacelift/)

### Version management and package publishing

[semantic-release](https://semantic-release.gitbook.io/semantic-release/) is used as a tool for automated version management and package publishing. See configuration [here](.github/workflows/release.yaml).
Expand Down

0 comments on commit f588282

Please sign in to comment.