Skip to content
Snippets Groups Projects
Unverified Commit 97d98230 authored by Timo Furrer's avatar Timo Furrer
Browse files

Do not use CI_PROJECT_PATH variable in README

parent 4a2bf8b6
No related branches found
No related tags found
No related merge requests found
...@@ -21,7 +21,7 @@ You find all releases on the [Releases Overview Page](https://gitlab.com/compone ...@@ -21,7 +21,7 @@ You find all releases on the [Releases Overview Page](https://gitlab.com/compone
```yaml ```yaml
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/full-pipeline@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/full-pipeline@<VERSION>
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -35,7 +35,7 @@ stages: [validate, test, build, deploy, cleanup] ...@@ -35,7 +35,7 @@ stages: [validate, test, build, deploy, cleanup]
# ... or without the destroy jobs: # ... or without the destroy jobs:
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/validate-plan-apply@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/validate-plan-apply@<VERSION>
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -51,7 +51,7 @@ A concrete example may look like this: ...@@ -51,7 +51,7 @@ A concrete example may look like this:
```yaml ```yaml
# Using version `0.10.0`: # Using version `0.10.0`:
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/full-pipeline@0.10.0 - component: $CI_SERVER_FQDN/components/opentofu/full-pipeline@0.10.0
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -66,7 +66,7 @@ stages: [validate, test, build, deploy, cleanup] ...@@ -66,7 +66,7 @@ stages: [validate, test, build, deploy, cleanup]
# ... in case you absolutely know what you are doing and are # ... in case you absolutely know what you are doing and are
# aware that this may introduce breaking changes, you may use the latest release: # aware that this may introduce breaking changes, you may use the latest release:
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/full-pipeline@~latest - component: $CI_SERVER_FQDN/components/opentofu/full-pipeline@~latest
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -81,7 +81,7 @@ Or import all jobs as hidden templates ready to be extended: ...@@ -81,7 +81,7 @@ Or import all jobs as hidden templates ready to be extended:
```yaml ```yaml
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/job-templates@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/job-templates@<VERSION>
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -114,7 +114,7 @@ and compose your own pipeline, for example, to just run the `fmt` job you can do ...@@ -114,7 +114,7 @@ and compose your own pipeline, for example, to just run the `fmt` job you can do
```yaml ```yaml
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/fmt@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/fmt@<VERSION>
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -131,7 +131,7 @@ you want to extend the jobs: ...@@ -131,7 +131,7 @@ you want to extend the jobs:
```yaml ```yaml
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/job-templates@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/job-templates@<VERSION>
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -187,7 +187,7 @@ the tools. For example to install `jq`: ...@@ -187,7 +187,7 @@ the tools. For example to install `jq`:
```yaml ```yaml
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/validate-plan@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/validate-plan@<VERSION>
inputs: inputs:
version: <VERSION> version: <VERSION>
opentofu_version: 1.6.1 opentofu_version: 1.6.1
...@@ -234,10 +234,10 @@ and as the `version` input. Check out the [Usage](#Usage) section for examples. ...@@ -234,10 +234,10 @@ and as the `version` input. Check out the [Usage](#Usage) section for examples.
Each component release deploys the following images: Each component release deploys the following images:
- `$CI_REGISTRY/$CI_PROJECT_PATH/gitlab-opentofu:<VERSION>-opentofu<OPENTOFU_VERSION>` - `$CI_REGISTRY/components/opentofu/gitlab-opentofu:<VERSION>-opentofu<OPENTOFU_VERSION>`
- `$CI_REGISTRY/$CI_PROJECT_PATH/gitlab-opentofu:<VERSION>-opentofu` - `$CI_REGISTRY/components/opentofu/gitlab-opentofu:<VERSION>-opentofu`
- Includes the latest stable OpenTofu version at the time of releasing the component - Includes the latest stable OpenTofu version at the time of releasing the component
- `$CI_REGISTRY/$CI_PROJECT_PATH/gitlab-opentofu:<VERSION>` - `$CI_REGISTRY/components/opentofu/gitlab-opentofu:<VERSION>`
- Includes the latest stable OpenTofu version at the time of releasing the component - Includes the latest stable OpenTofu version at the time of releasing the component
In the above examples `<VERSION>` references the component version and `<OPENTOFU_VERSION>` In the above examples `<VERSION>` references the component version and `<OPENTOFU_VERSION>`
......
...@@ -8,7 +8,7 @@ You can use the OpenTofu CI/CD component from the CI/CD catalog using: ...@@ -8,7 +8,7 @@ You can use the OpenTofu CI/CD component from the CI/CD catalog using:
```yaml ```yaml
include: include:
- component: $CI_COMMIT_TAG/$CI_PROJECT_PATH/full-pipeline@$CI_COMMIT_TAG - component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/full-pipeline@$CI_COMMIT_TAG
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
......
...@@ -23,7 +23,7 @@ You find all releases on the [Releases Overview Page](https://gitlab.com/compone ...@@ -23,7 +23,7 @@ You find all releases on the [Releases Overview Page](https://gitlab.com/compone
```yaml ```yaml
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/full-pipeline@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/full-pipeline@<VERSION>
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -37,7 +37,7 @@ stages: [validate, test, build, deploy, cleanup] ...@@ -37,7 +37,7 @@ stages: [validate, test, build, deploy, cleanup]
# ... or without the destroy jobs: # ... or without the destroy jobs:
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/validate-plan-apply@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/validate-plan-apply@<VERSION>
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -53,7 +53,7 @@ A concrete example may look like this: ...@@ -53,7 +53,7 @@ A concrete example may look like this:
```yaml ```yaml
# Using version `0.10.0`: # Using version `0.10.0`:
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/full-pipeline@0.10.0 - component: $CI_SERVER_FQDN/components/opentofu/full-pipeline@0.10.0
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -68,7 +68,7 @@ stages: [validate, test, build, deploy, cleanup] ...@@ -68,7 +68,7 @@ stages: [validate, test, build, deploy, cleanup]
# ... in case you absolutely know what you are doing and are # ... in case you absolutely know what you are doing and are
# aware that this may introduce breaking changes, you may use the latest release: # aware that this may introduce breaking changes, you may use the latest release:
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/full-pipeline@~latest - component: $CI_SERVER_FQDN/components/opentofu/full-pipeline@~latest
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -83,7 +83,7 @@ Or import all jobs as hidden templates ready to be extended: ...@@ -83,7 +83,7 @@ Or import all jobs as hidden templates ready to be extended:
```yaml ```yaml
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/job-templates@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/job-templates@<VERSION>
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -116,7 +116,7 @@ and compose your own pipeline, for example, to just run the `fmt` job you can do ...@@ -116,7 +116,7 @@ and compose your own pipeline, for example, to just run the `fmt` job you can do
```yaml ```yaml
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/fmt@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/fmt@<VERSION>
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -133,7 +133,7 @@ you want to extend the jobs: ...@@ -133,7 +133,7 @@ you want to extend the jobs:
```yaml ```yaml
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/job-templates@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/job-templates@<VERSION>
inputs: inputs:
# The version must currently be specified explicitly as an input, # The version must currently be specified explicitly as an input,
# to find the correctly associated images. # This can be removed # to find the correctly associated images. # This can be removed
...@@ -212,7 +212,7 @@ the tools. For example to install `jq`: ...@@ -212,7 +212,7 @@ the tools. For example to install `jq`:
```yaml ```yaml
include: include:
- component: $CI_SERVER_FQDN/$CI_PROJECT_PATH/validate-plan@<VERSION> - component: $CI_SERVER_FQDN/components/opentofu/validate-plan@<VERSION>
inputs: inputs:
version: <VERSION> version: <VERSION>
opentofu_version: 1.6.1 opentofu_version: 1.6.1
...@@ -259,10 +259,10 @@ and as the `version` input. Check out the [Usage](#Usage) section for examples. ...@@ -259,10 +259,10 @@ and as the `version` input. Check out the [Usage](#Usage) section for examples.
Each component release deploys the following images: Each component release deploys the following images:
- `$CI_REGISTRY/$CI_PROJECT_PATH/gitlab-opentofu:<VERSION>-opentofu<OPENTOFU_VERSION>` - `$CI_REGISTRY/components/opentofu/gitlab-opentofu:<VERSION>-opentofu<OPENTOFU_VERSION>`
- `$CI_REGISTRY/$CI_PROJECT_PATH/gitlab-opentofu:<VERSION>-opentofu` - `$CI_REGISTRY/components/opentofu/gitlab-opentofu:<VERSION>-opentofu`
- Includes the latest stable OpenTofu version at the time of releasing the component - Includes the latest stable OpenTofu version at the time of releasing the component
- `$CI_REGISTRY/$CI_PROJECT_PATH/gitlab-opentofu:<VERSION>` - `$CI_REGISTRY/components/opentofu/gitlab-opentofu:<VERSION>`
- Includes the latest stable OpenTofu version at the time of releasing the component - Includes the latest stable OpenTofu version at the time of releasing the component
In the above examples `<VERSION>` references the component version and `<OPENTOFU_VERSION>` In the above examples `<VERSION>` references the component version and `<OPENTOFU_VERSION>`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment