Skip to content

Commit

Permalink
feat(promotion): update promotion references
Browse files Browse the repository at this point in the history
  • Loading branch information
danilo-gemoli committed Dec 19, 2023
1 parent d796991 commit d194220
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 32 deletions.
5 changes: 3 additions & 2 deletions content/en/docs/architecture/branching.md
Expand Up @@ -68,8 +68,9 @@ Ensure that the promotion stanza in your `ci-operator` configuration for your [d

{{< highlight yaml >}}
promotion:
namespace: ocp
name: 4.3
to:
- namespace: ocp
name: 4.3
{{< / highlight >}}

{{< alert title="Warning" color="warning" >}}
Expand Down
45 changes: 24 additions & 21 deletions content/en/docs/architecture/ci-operator.md
Expand Up @@ -314,12 +314,13 @@ allows release payloads to be created incorporating the latest tested version of

{{< highlight yaml >}}
promotion:
additional_images:
repo-scripts: "src" # promotes "src" as "repo-scripts"
excluded_images:
- "mytests" # does not promote the test image
namespace: "ocp"
name: "4.5"
to:
- additional_images:
repo-scripts: "src" # promotes "src" as "repo-scripts"
excluded_images:
- "mytests" # does not promote the test image
namespace: "ocp"
name: "4.5"
{{< / highlight >}}

### Publishing to an Integration Namespace
Expand All @@ -335,12 +336,13 @@ add the following `promotion` stanza to `ci-operator` configuration.

{{< highlight yaml >}}
promotion:
additional_images:
repo-scripts: "src" # promotes "src" as "repo-scripts"
excluded_images:
- "mytests" # does not promote the test image
namespace: "ocp"
tag: "4.5"
to:
- additional_images:
repo-scripts: "src" # promotes "src" as "repo-scripts"
excluded_images:
- "mytests" # does not promote the test image
namespace: "ocp"
tag: "4.5"
{{< / highlight >}}

### Publishing Images Tagged By Commit
Expand All @@ -358,13 +360,14 @@ that tracks the `latest` or most recent release, add `tag_by_commit: true` to th

{{< highlight yaml >}}
promotion:
additional_images:
repo-scripts: "src" # promotes "src" as "repo-scripts"
excluded_images:
- "mytests" # does not promote the test image
namespace: "ocp"
tag: "4.5"
tag_by_commit: true # publish tags based on the git commit being built
to:
- additional_images:
repo-scripts: "src" # promotes "src" as "repo-scripts"
excluded_images:
- "mytests" # does not promote the test image
namespace: "ocp"
tag: "4.5"
tag_by_commit: true # publish tags based on the git commit being built
{{< / highlight >}}

## Describing OpenShift Releases Involved in Tests {#describing-inclusion-in-an-openshift-release}
Expand Down Expand Up @@ -739,8 +742,8 @@ installer will use pipeline:installer if that tag is present, falling back to st
configuration fields use this defaulting mechanism:

* `images[*].from`: configuring the base `FROM` which an image builds
* `promotion.additional_images`: configuring which `images` are published
* `promotion.excluded_images`: configuring which `images` are not published
* `promotion.to[*].additional_images`: configuring which `images` are published
* `promotion.to[*].excluded_images`: configuring which `images` are not published
* `tests[*].container.from`: configuring the container image in which a single-stage test runs
* `tests[*].steps.{pre,test,post}[*].from`: configuring the container image which some part of a multi-stage test runs

Expand Down
11 changes: 6 additions & 5 deletions content/en/docs/getting-started/examples.md
Expand Up @@ -60,11 +60,12 @@ In the following `ci-operator` configuration, the following `images` are promote
{{< highlight yaml >}}
test_binary_build_commands: go test -race -c -o e2e-tests # will create the test-bin tag
promotion:
additional_images:
repo-scripts: src # promotes "src" as "repo-scripts"
repo-tests: test-bin # promotes "test-bin" as "repo-tests"
namespace: ocp
name: 4.4
to:
- additional_images:
repo-scripts: src # promotes "src" as "repo-scripts"
repo-tests: test-bin # promotes "test-bin" as "repo-tests"
namespace: ocp
name: 4.4
images:
- from: ubi8
to: component # promotes "component" by default
Expand Down
10 changes: 6 additions & 4 deletions content/en/docs/how-tos/use-registries-in-build-farm.md
Expand Up @@ -236,8 +236,9 @@ images:
from: base
to: my-component
promotion:
name: "4.7"
namespace: ocp
to:
- name: "4.7"
namespace: ocp
```

The `my-component` image can be pulled from the authoritative registry with:
Expand All @@ -257,8 +258,9 @@ images:
from: base
to: my-component
promotion:
namespace: my-organization
tag: latest
to:
- namespace: my-organization
tag: latest
```

The `my-component` image can be pulled from the authoritative registry with:
Expand Down

0 comments on commit d194220

Please sign in to comment.