Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
OpenTofu
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
components
OpenTofu
Commits
fce339ac
Commit
fce339ac
authored
2 months ago
by
Timo Furrer
Browse files
Options
Downloads
Patches
Plain Diff
Make use of some beautiful GitLab markdown alerts
parent
e0a286e7
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
.gitlab/README.md.template
+25
-10
25 additions, 10 deletions
.gitlab/README.md.template
README.md
+25
-10
25 additions, 10 deletions
README.md
with
50 additions
and
20 deletions
.gitlab/README.md.template
+
25
−
10
View file @
fce339ac
...
...
@@ -4,21 +4,27 @@ This project is home to the **OpenTofu CI/CD component** and it's related assets
like the `gitlab-tofu` wrapper script and OCI images containing that script
together with an OpenTofu version.
Read more:
- [CI/CD components](https://docs.gitlab.com/ee/ci/components)
- [Development guide for GitLab CI/CD components](https://docs.gitlab.com/ee/development/cicd/components)
- [CI/CD Catalog](https://docs.gitlab.com/ee/ci/components/index.html#cicd-catalog)
**Note**: Please make sure to use a released version of this CI/CD component.
You find all releases on the [Releases Overview Page](https://gitlab.com/components/opentofu/-/releases).
♻️ **Migrating from the Terraform CI/CD templates?** Check **[this](#migrating-from-the-terraform-cicd-templates)** out.
> [!note]
> Please make sure to use a released version of this CI/CD component.
> You find all releases on the [Releases Overview Page](https://gitlab.com/components/opentofu/-/releases).
> [!tip]
> GitLab CI/CD components and the CI/CD catalog are fairly recent additions to GitLab.
> You can learn more about them here:
>
> - [CI/CD components](https://docs.gitlab.com/ee/ci/components)
> - [Development guide for GitLab CI/CD components](https://docs.gitlab.com/ee/development/cicd/components)
> - [CI/CD Catalog](https://docs.gitlab.com/ee/ci/components/index.html#cicd-catalog)
>
>♻️ **Migrating from the Terraform CI/CD templates?** Check **[this](#migrating-from-the-terraform-cicd-templates)** out.
[[_TOC_]]
## Usage
> [!tip]
> The usage examples use `<...>` pattern for placeholders that you must replace with your desired values.
```yaml
include:
- component: $CI_SERVER_FQDN/components/opentofu/full-pipeline@<VERSION>
...
...
@@ -124,6 +130,10 @@ The base image OS can be specified with the `base_os` input.
### GitLab-managed Terraform state backend
> [!tip]
> Consider using `auto_define_backend: true` to let the component automatically set up
> the OpenTofu HTTP backend configuration block.
This component - by leveraging the [`gitlab-tofu`](src/gitlab-tofu.sh) CLI internally -
can automatically define and configure the
[GitLab-managed Terraform state backend](https://docs.gitlab.com/ee/user/infrastructure/iac/terraform_state.html).
...
...
@@ -142,6 +152,11 @@ However, you may simply enable the `auto_define_backend` so that the component t
### State and Plan Encryption
> [!tip]
> State and Plan encryption is not enabled by default which may impact security negatively
> for your use case. Please consider using it. The example below gives you a good sense
> of how easy it is to enable.
We recommend that you configure the OpenTofu
[State and Plan Encryption](https://opentofu.org/docs/language/state/encryption).
...
...
This diff is collapsed.
Click to expand it.
README.md
+
25
−
10
View file @
fce339ac
...
...
@@ -6,21 +6,27 @@ This project is home to the **OpenTofu CI/CD component** and it's related assets
like the
`gitlab-tofu`
wrapper script and OCI images containing that script
together with an OpenTofu version.
Read more:
-
[
CI/CD components
](
https://docs.gitlab.com/ee/ci/components
)
-
[
Development guide for GitLab CI/CD components
](
https://docs.gitlab.com/ee/development/cicd/components
)
-
[
CI/CD Catalog
](
https://docs.gitlab.com/ee/ci/components/index.html#cicd-catalog
)
**Note**
: Please make sure to use a released version of this CI/CD component.
You find all releases on the
[
Releases Overview Page
](
https://gitlab.com/components/opentofu/-/releases
)
.
♻️
**Migrating from the Terraform CI/CD templates?**
Check
**[this](#migrating-from-the-terraform-cicd-templates)**
out.
> [!note]
> Please make sure to use a released version of this CI/CD component.
> You find all releases on the [Releases Overview Page](https://gitlab.com/components/opentofu/-/releases).
> [!tip]
> GitLab CI/CD components and the CI/CD catalog are fairly recent additions to GitLab.
> You can learn more about them here:
>
> - [CI/CD components](https://docs.gitlab.com/ee/ci/components)
> - [Development guide for GitLab CI/CD components](https://docs.gitlab.com/ee/development/cicd/components)
> - [CI/CD Catalog](https://docs.gitlab.com/ee/ci/components/index.html#cicd-catalog)
>
>♻️ **Migrating from the Terraform CI/CD templates?** Check **[this](#migrating-from-the-terraform-cicd-templates)** out.
[[
_TOC_
]]
## Usage
> [!tip]
> The usage examples use `<...>` pattern for placeholders that you must replace with your desired values.
```
yaml
include
:
-
component
:
$CI_SERVER_FQDN/components/opentofu/full-pipeline@<VERSION>
...
...
@@ -126,6 +132,10 @@ The base image OS can be specified with the `base_os` input.
### GitLab-managed Terraform state backend
> [!tip]
> Consider using `auto_define_backend: true` to let the component automatically set up
> the OpenTofu HTTP backend configuration block.
This component - by leveraging the
[
`gitlab-tofu`
](
src/gitlab-tofu.sh
)
CLI internally -
can automatically define and configure the
[
GitLab-managed Terraform state backend
](
https://docs.gitlab.com/ee/user/infrastructure/iac/terraform_state.html
)
.
...
...
@@ -144,6 +154,11 @@ However, you may simply enable the `auto_define_backend` so that the component t
### State and Plan Encryption
> [!tip]
> State and Plan encryption is not enabled by default which may impact security negatively
> for your use case. Please consider using it. The example below gives you a good sense
> of how easy it is to enable.
We recommend that you configure the OpenTofu
[
State and Plan Encryption
](
https://opentofu.org/docs/language/state/encryption
)
.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment