Commit 63436b2a authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: use variabilized GitLab server FQDN in CI/CD component reference URLs

parent ede9b047

README.md

+9 −9
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ Add the following to your `.gitlab-ci.yml`: 
```yaml

include:

  # 1: include the component

  - component: gitlab.com/to-be-continuous/docker/gitlab-ci-docker@5.11.0

  - component: $CI_SERVER_FQDN/to-be-continuous/docker/gitlab-ci-docker@5.11.0

    # 2: set/override component inputs

    inputs:

      build-tool: buildah # ⚠ this is only an example
@@ -529,7 +529,7 @@ Here is a `.gitlab-ci.yaml` using an external Docker registry: 


```yaml

include:

  - component: gitlab.com/to-be-continuous/docker/gitlab-ci-docker@5.7.0

  - component: $CI_SERVER_FQDN/to-be-continuous/docker/gitlab-ci-docker@5.7.0

    inputs:

      snapshot-image: "registry.acme.host/$CI_PROJECT_NAME/snapshot:$CI_COMMIT_REF_SLUG"

      release-image: "registry.acme.host/$CI_PROJECT_NAME:$CI_COMMIT_REF_NAME"
@@ -544,7 +544,7 @@ Here is a `.gitlab-ci.yaml` that builds 2 Docker images from the same project (u 


```yaml

include:

  - component: gitlab.com/to-be-continuous/docker/gitlab-ci-docker@5.7.0

  - component: $CI_SERVER_FQDN/to-be-continuous/docker/gitlab-ci-docker@5.7.0



.docker-base:

  parallel:
@@ -597,9 +597,9 @@ With: 
```yaml

include:

  # main template

  - component: gitlab.com/to-be-continuous/docker/gitlab-ci-docker@5.7.0

  - component: $CI_SERVER_FQDN/to-be-continuous/docker/gitlab-ci-docker@5.7.0

  # Vault variant

  - component: gitlab.com/to-be-continuous/docker/gitlab-ci-docker-vault@5.7.0

  - component: $CI_SERVER_FQDN/to-be-continuous/docker/gitlab-ci-docker-vault@5.7.0

    inputs:

      # audience claim for JWT

      vault-oidc-aud: "https://vault.acme.host"
@@ -646,7 +646,7 @@ to use the snapshot image repository (will host your snapshot image as well as c 


```yaml

include:

  - component: gitlab.com/to-be-continuous/docker/gitlab-ci-docker@5.7.0

  - component: $CI_SERVER_FQDN/to-be-continuous/docker/gitlab-ci-docker@5.7.0

    inputs:

      build-tool: "kaniko" # Only Kaniko has been proved to work for this use case YET

      # untested & unverified container image
@@ -654,7 +654,7 @@ include: 
      # ⚠ don't forget to create the '{GCP_REGION}-docker.pkg.dev/{GCP_PROJECT_ID}/{YOUR_REPOSITORY}/{YOUR_IMAGE_NAME}/snapshot/cache' repo for Kaniko

      # validated container image (published)

      release-image: "{GCP_REGION}-docker.pkg.dev/{GCP_PROJECT_ID}/{YOUR_REPOSITORY}/{YOUR_IMAGE_NAME}:$CI_COMMIT_REF_NAME"

  - component: gitlab.com/to-be-continuous/docker/gitlab-ci-docker-gcp@5.7.0

  - component: $CI_SERVER_FQDN/to-be-continuous/docker/gitlab-ci-docker-gcp@5.7.0

    inputs:

      # default WIF provider

      gcp-oidc-provider: "projects/{GCP_PROJECT_NUMBER}/locations/global/workloadIdentityPools/{YOUR_WIF_POOL_NAME}/providers/gitlab-diod"
@@ -719,14 +719,14 @@ then set the required configuration. 


```yaml

include:

  - component: gitlab.com/to-be-continuous/docker/gitlab-ci-docker@5.7.0

  - component: $CI_SERVER_FQDN/to-be-continuous/docker/gitlab-ci-docker@5.7.0

    inputs:

      # untested & unverified container image

      snapshot-image: "123456789012.dkr.ecr.us-east-1.amazonaws.com/$CI_PROJECT_PATH_SLUG/snapshot:$CI_COMMIT_REF_SLUG"

      # ⚠ don't forget to create the '123456789012.dkr.ecr.us-east-1.amazonaws.com/$CI_PROJECT_PATH/snapshot/cache' repo for Kaniko

      # validated container image (published)

      release-image: "123456789012.dkr.ecr.us-east-1.amazonaws.com/$CI_PROJECT_PATH_SLUG:$CI_COMMIT_REF_NAME"

  - component: gitlab.com/to-be-continuous/docker/gitlab-ci-docker-ecr@5.7.0

  - component: $CI_SERVER_FQDN/to-be-continuous/docker/gitlab-ci-docker-ecr@5.7.0

    inputs:

      # default Role ARN (using OIDC authentication method)

      aws-oidc-role-arn: "arn:aws:iam::123456789012:role/gitlab-ci"