Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit13d1243

Browse files
authored
Q2 s3 google artifact container registry (#773)
* Update ci-integrations.mdAdded argument set for GAR integrations* Update ci-integrations.mdAdded block of new container registry parameters for DockerHub with explicit credentials, generic container registry and Google artifact registry* Update ci-integrations.mdFormatting updates* Update container registry options and paramsEdited descriptions of additional container registry params acc to feedback from Denis
1 parent185183d commit13d1243

File tree

4 files changed

+32
-15
lines changed

4 files changed

+32
-15
lines changed

‎_docs/gitops-integrations/ci-integrations.md‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -57,17 +57,6 @@ max-width="50%"
5757
{:start="5"}
5858
1. If required, click**Close**, update as needed and generate the manifest again.
5959
1. If there are no validation errors, click**Copy**.
60-
61-
{% include image.html
62-
lightbox="true"
63-
file="/images/integrations/classic/classic-manifest.png"
64-
url="/images/integrations/classic/classic-manifest.png"
65-
alt="Example of manifest generated for Codefresh pipeline"
66-
caption="Example of manifest generated for Codefresh pipeline"
67-
max-width="50%"
68-
%}
69-
70-
{:start="6"}
7160
1. Paste the copied manifest as the last step in your CI pipeline.
7261

7362
##CI integration argument reference
@@ -80,7 +69,14 @@ The table describes _all_ the arguments required for CI integrations in general.
8069
|`CF_RUNTIME_NAME`| The runtime to use for the integration. If you have more than one runtime, select the runtime from the list.| Required|
8170
|`CF_PLATFORM_URL`| The root URL of the Codefresh application. The default value is`https://g.codefresh.io`.| Optional|
8271
|`CF_API_KEY`| The API key for authentication. Generate the key for the integration.| Required|
83-
|`CF_CONTAINER_REGISTRY_INTEGRATION`| The name of the container registry integration created in Codefresh where the image is stored. See[Container registry integrations]({{site.baseurl}}/docs/gitops-integrations/container-registries/).| Optional|
72+
|`CF_CONTAINER_REGISTRY_INTEGRATION`| The name of the container registry integration created in Codefresh where the image is stored to reference in the CI pipeline. See[Container registry integrations]({{site.baseurl}}/docs/gitops-integrations/container-registries/).<br>Alternatively, you can use_one_ of these container registries with explicit credentials:{::nomarkdown} <ul><li>DockerHub registry with <codeclass="highlighter-rouge"> CF_DOCKERHUB_USERNAME</code> and <codeclass="highlighter-rouge">CF_DOCKERHUB_PASSWORD</code>.</li><li><ahref="https://docs.docker.com/registry/spec/api/">Docker Registry Protocol v2</a> with <codeclass="highlighter-rouge"> CF_REGISTRY_DOMAIN</code>, <codeclass="highlighter-rouge"> CF_REGISTRY_USERNAME</code>, and <codeclass="highlighter-rouge">CF_REGISTRY_PASSWORD</code>.</li><li>Google Artifact Registry (GAR) with <codeclass="highlighter-rouge"> CF_GOOGLE_JSON_KEY</code> and <codeclass="highlighter-rouge">CF_GOOGLE_REGISTRY_HOST</code>.</li></ul>{:/}| Optional|
73+
|`CF_DOCKERHUB_USERNAME`| Relevant only to provide explicit credentials to the Docker Hub container registry where the image is stored. <br>The username for the Docker Hub container registry.<br><br>To use a Docker Hub container registry integration created in Codefresh, set`CF_CONTAINER_REGISTRY_INTEGRATION` instead.| Optional|
74+
|`CF_DOCKERHUB_PASSWORD`| Relevant only if`CF_DOCKERHUB_USERNAME` is specified.<br>The password for the Docker Hub container registry.| Optional|
75+
|`CF_REGISTRY_USERNAME`| Relevant for container registries that support[Docker Registry Protocol v2](https://docs.docker.com/registry/spec/api/){:target="\_blank"}. <br>The username for the Docker Registry Protocol v2 container registry. <br><br>To use a container registry integration created in Codefresh, set`CF_CONTAINER_REGISTRY_INTEGRATION` instead.| Optional|
76+
|`CF_REGISTRY_PASSWORD`| Relevant only if`CF_REGISTRY_USERNAME` is specified.<br> The password for the Docker Registry Protocol v2 container registry.| Optional|
77+
|`CF_REGISTRY_DOMAIN`| Relevant only if`CF_REGISTRY_USERNAME` and`CF_REGISTRY_PASSWORD` are specified. <br> The domain for the Docker Registry Protocol v2 container registry.| Optional|
78+
|`CF_GOOGLE_JSON_KEY`| Relevant only for Google Artifact Registry (GAR) or Google Container Registry (GCR).<br> The Google Cloud Platform Service Account key in JSON format to authenticate to GAR or GCR.| Optional|
79+
|`CF_GOOGLE_REGISTRY_HOST`| Relevant only if`CF_GOOGLE_JSON_KEY` is specified.<br>The GAR or GCR host. <br>For example,`us-central1-docker.pkg.dev` or`gcr.io`.| Optional|
8480
|`CF_JIRA_INTEGRATION` |_Deprecated from version 0.0.565 and higher._ Replaced by`CF_ISSUE_TRACKING_INTEGRATION`. |_Deprecated_
8581
|`CF_ISSUE_TRACKING_INTEGRATION`| The name of the issue tracking integration created in Codefresh to use for image enrichment. Relevant only if Jira enrichment is required for the image. If you don't have a Jira integration, click**Create Atlassian Jira Integration** and configure settings. See[Jira integration]({{site.baseurl}}/docs/gitops-integrations/issue-tracking/jira/).| Optional|
8682
|`CF_IMAGE`| The image to be enriched and reported in Codefresh. Pass the`[account-name]/[image-name]:[tag]` built in your CI.| Required|

‎_docs/gitops-integrations/ci-integrations/codefresh-classic.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,14 @@ For the complete argument reference, see [CI integration for GitOps argument ref
9191
|`CF_RUNTIME_NAME`| The runtime to use for the integration. If you have more than one runtime, select the runtime from the list.| Required|
9292
|`CF_PLATFORM_URL`| The root URL of the Codefresh application. The default value is`https://g.codefresh.io`.| Optional|
9393
|`CF_API_KEY`| The API key to authenticate the Codefresh pipeline user to Codefresh. Generate the key for the integration.| Required|
94-
|`CF_CONTAINER_REGISTRY_INTEGRATION`| The name of the container registry integration created in Codefresh where the image is stored. To create a container registry integration if you don't have one, click**Create Container Registry Integration**, and then configure the settings. See[Container registry integrations]({{site.baseurl}}/docs/gitops-integrations/container-registries/).| Optional|
94+
| `CF_CONTAINER_REGISTRY_INTEGRATION` | The name of the container registry integration created in Codefresh where the image is stored to reference in the CI pipeline. See [Container registry integrations]({{site.baseurl}}/docs/gitops-integrations/container-registries/).<br><br>Alternatively, you can use _one_ of these container registries with explicit credentials:{::nomarkdown} <ul><li>DockerHub registry with <code class="highlighter-rouge"> CF_DOCKERHUB_USERNAME</code> and <code class="highlighter-rouge">CF_DOCKERHUB_PASSWORD</code>.</li><li><a href="https://docs.docker.com/registry/spec/api/">Docker Registry Protocol v2</a> with <code class="highlighter-rouge"> CF_REGISTRY_DOMAIN</code>, <code class="highlighter-rouge"> CF_REGISTRY_USERNAME</code>, and <code class="highlighter-rouge">CF_REGISTRY_PASSWORD</code>.</li><li>Google Artifact Registry (GAR) with <code class="highlighter-rouge"> CF_GOOGLE_JSON_KEY</code> and <code class="highlighter-rouge">CF_GOOGLE_REGISTRY_HOST</code>.</li></ul>{:/}| Optional |
95+
|`CF_DOCKERHUB_USERNAME`| Relevant only to provide explicit credentials to the Docker Hub container registry where the image is stored. <br>The username for the Docker Hub container registry.<br><br>To use a Docker Hub container registry integration created in Codefresh, set`CF_CONTAINER_REGISTRY_INTEGRATION` instead.| Optional|
96+
|`CF_DOCKERHUB_PASSWORD`| Relevant only if`CF_DOCKERHUB_USERNAME` is specified.<br>The password for the Docker Hub container registry.| Optional|
97+
|`CF_REGISTRY_USERNAME`| Relevant for container registries that support[Docker Registry Protocol v2](https://docs.docker.com/registry/spec/api/){:target="\_blank"}. <br>The username for the Docker Registry Protocol v2 container registry. <br><br>To use a container registry integration created in Codefresh, set`CF_CONTAINER_REGISTRY_INTEGRATION` instead.| Optional|
98+
|`CF_REGISTRY_PASSWORD`| Relevant only if`CF_REGISTRY_USERNAME` is specified.<br> The password for the Docker Registry Protocol v2 container registry.| Optional|
99+
|`CF_REGISTRY_DOMAIN`| Relevant only if`CF_REGISTRY_USERNAME` and`CF_REGISTRY_PASSWORD` are specified. <br> The domain for the Docker Registry Protocol v2 container registry.| Optional|
100+
|`CF_GOOGLE_JSON_KEY`| Relevant only for Google Artifact Registry (GAR) or Google Container Registry (GCR).<br> The Google Cloud Platform Service Account key in JSON format to authenticate to GAR or GCR.| Optional|
101+
|`CF_GOOGLE_REGISTRY_HOST`| Relevant only if`CF_GOOGLE_JSON_KEY` is specified.<br>The GAR or GCR host. <br>For example,`us-central1-docker.pkg.dev` or`gcr.io`.| Optional|
95102
|`CF_JIRA_INTEGRATION` | Deprecated from version 0.0.565. Replaced by`CF_ISSUE_TRACKING_INTEGRATION`. |_Deprecated_
96103
|`CF_ISSUE_TRACKING_INTEGRATION`| The name of the issue tracking integration created in Codefresh to use to enrich the image. Relevant only if Jira enrichment is required for the image. If you don't have a Jira integration, click**Create Atlassian Jira Integration** and configure settings. See[Jira integration]({{site.baseurl}}/docs/gitops-integrations/issue-tracking/jira/).| Optional|
97104
|`CF_IMAGE`| The image to be enriched and reported in Codefresh. Pass the`[account-name]/[image-name]:[tag]` built in your CI.| Required|

‎_docs/gitops-integrations/ci-integrations/github-actions.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,14 @@ The table describes the arguments required to connect a GitHub Action to Codefre
111111
|`CF_RUNTIME_NAME`| The runtime to use for the integration. If you have more than one runtime, select the runtime from the list.| Required|
112112
|`CF_PLATFORM_URL`| The root URL of the Codefresh application. The default value is`https://g.codefresh.io`.| Optional|
113113
|`CF_API_KEY`| The API key to authenticate the GitHub Actions user to Codefresh. Generate the key for the GitHub Action. {::nomarkdown}<br>Enter this token in GitHub Actions <ahref="https://docs.github.com/en/actions/security-guides/encrypted-secrets"target=”_blank”>as a secret</a> with the name <codeclass="highlighter-rouge">CF_API_KEY</code>. You can then reference it in all GitHub pipelines as you would any other secret.{:/}| Required|
114-
|`CF_CONTAINER_REGISTRY_INTEGRATION`| The name of the container registry integration created in Codefresh where the image is stored. {::nomarkdown}<br><ul><li>For a GitHub Container registry, select <codeclass="highlighter-rouge">GHCR_GITHUB_TOKEN_AUTHENTICATION</code> even if you have not created an integration in Codefresh.<br>Codefresh retrieves and provides the explicit credentials for the container registry on generating the integration manifest.</li> <li>To create a container registry integration if you don't have one, click <b>Create Container Registry Integration</b>, and then configure the settings.<br>See <ahref="https://codefresh.io/docs/docs/gitops-integrations/container-registries/">Container registry integrations</a>.</li></ul>{:/}| Optional|
114+
| `CF_CONTAINER_REGISTRY_INTEGRATION` | The name of the container registry integration created in Codefresh where the image is stored. {::nomarkdown}<br><ul><li>For a GitHub Container registry, select <code class="highlighter-rouge">GHCR_GITHUB_TOKEN_AUTHENTICATION</code> even if you have not created an integration in Codefresh.<br>Codefresh retrieves and provides the explicit credentials for the container registry on generating the integration manifest.</li> <li>To create a container registry integration in Codefresh, if you don't have one, click <b>Create Container Registry Integration</b>, and then configure the settings.<br>See <a href="https://codefresh.io/docs/docs/gitops-integrations/container-registries/">Container registry integrations</a>.</li><li>Alternatively, you can use <i>one</i> of these container registries with explicit credentials:<ul><li>DockerHub registry with <code class="highlighter-rouge"> CF_DOCKERHUB_USERNAME</code> and <code class="highlighter-rouge">CF_DOCKERHUB_PASSWORD</code>.</li><li><a href="https://docs.docker.com/registry/spec/api/">Docker Registry Protocol v2</a> with <code class="highlighter-rouge"> CF_REGISTRY_DOMAIN</code>, <code class="highlighter-rouge"> CF_REGISTRY_USERNAME</code>, and <code class="highlighter-rouge">CF_REGISTRY_PASSWORD</code>.</li><li>Google Artifact Registry (GAR) with <code class="highlighter-rouge"> CF_GOOGLE_JSON_KEY</code> and <code class="highlighter-rouge">CF_GOOGLE_REGISTRY_HOST</code>.</li></li></ul></ul>{:/} | Optional |
115+
|`CF_DOCKERHUB_USERNAME`| Relevant only to provide explicit credentials to the Docker Hub container registry where the image is stored. <br>The username for the Docker Hub container registry.<br><br>To use a Docker Hub container registry integration created in Codefresh, set`CF_CONTAINER_REGISTRY_INTEGRATION` instead.| Optional|
116+
|`CF_DOCKERHUB_PASSWORD`| Relevant only if`CF_DOCKERHUB_USERNAME` is specified.<br>The password for the Docker Hub container registry.| Optional|
117+
|`CF_REGISTRY_USERNAME`| Relevant for container registries that support[Docker Registry Protocol v2](https://docs.docker.com/registry/spec/api/){:target="\_blank"}. <br>The username for the Docker Registry Protocol v2 container registry. <br><br>To use a container registry integration created in Codefresh, set`CF_CONTAINER_REGISTRY_INTEGRATION` instead.| Optional|
118+
|`CF_REGISTRY_PASSWORD`| Relevant only if`CF_REGISTRY_USERNAME` is specified.<br> The password for the Docker Registry Protocol v2 container registry.| Optional|
119+
|`CF_REGISTRY_DOMAIN`| Relevant only if`CF_REGISTRY_USERNAME` and`CF_REGISTRY_PASSWORD` are specified. <br> The domain for the Docker Registry Protocol v2 container registry.| Optional|
120+
|`CF_GOOGLE_JSON_KEY`| Relevant only for Google Artifact Registry (GAR) or Google Container Registry (GCR).<br> The Google Cloud Platform Service Account key in JSON format to authenticate to GAR or GCR.| Optional|
121+
|`CF_GOOGLE_REGISTRY_HOST`| Relevant only if`CF_GOOGLE_JSON_KEY` is specified.<br>The GAR or GCR host. <br>For example,`us-central1-docker.pkg.dev` or`gcr.io`.| Optional|
115122
|`CF_GIT_REPO`| The Git repository with the configuration and code used to build the image. If not defined, Codefresh retrieves it from the repo defined for the GitHub Action.| Required|
116123
|`CF_JIRA_INTEGRATION` | Deprecated from version 0.0.565. Replaced by`CF_ISSUE_TRACKING_INTEGRATION`. |_Deprecated_
117124
|`CF_ISSUE_TRACKING_INTEGRATION`| The name of the issue tracking integration created in Codefresh to use to enrich the image. Relevant only if Jira enrichment is required for the image. If you don't have a Jira integration, click**Create Atlassian Jira Integration** and configure settings. See[Jira integration]({{site.baseurl}}/docs/gitops-integrations/issue-tracking/jira/).| Optional|

‎_docs/gitops-integrations/ci-integrations/jenkins.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,14 @@ The table describes the arguments to connect Codefresh pipelines to Codefresh Gi
119119
|`CF_RUNTIME_NAME`| The runtime to use for the integration. If you have more than one runtime, select the runtime from the list.| Required|
120120
|`CF_PLATFORM_URL`| The root URL of the Codefresh application. The default value is`https://g.codefresh.io`.| Optional|
121121
|`CF_API_KEY`| The API key to authenticate the Codefresh pipeline user to Codefresh. Generate the key for the integration.| Required|
122-
|`CF_CONTAINER_REGISTRY_INTEGRATION`| The name of the container registry integration created in Codefresh where the image is stored. To create a container registry integration if you don't have one, click**Create Container Registry Integration**, and then configure the settings. See[Container registry integrations]({{site.baseurl}}/docs/gitops-integrations/container-registries/).| Optional|
122+
| `CF_CONTAINER_REGISTRY_INTEGRATION` | The name of the container registry integration created in Codefresh where the image is stored to reference in the CI pipeline. See [Container registry integrations]({{site.baseurl}}/docs/gitops-integrations/container-registries/).<br><br>Alternatively, you can use _one_ of these container registries with explicit credentials:{::nomarkdown} <ul><li>DockerHub registry with <code class="highlighter-rouge"> CF_DOCKERHUB_USERNAME</code> and <code class="highlighter-rouge">CF_DOCKERHUB_PASSWORD</code>.</li><li><a href="https://docs.docker.com/registry/spec/api/">Docker Registry Protocol v2</a> with <code class="highlighter-rouge"> CF_REGISTRY_DOMAIN</code>, <code class="highlighter-rouge"> CF_REGISTRY_USERNAME</code>, and <code class="highlighter-rouge">CF_REGISTRY_PASSWORD</code>.</li><li>Google Artifact Registry (GAR) with <code class="highlighter-rouge"> CF_GOOGLE_JSON_KEY</code> and <code class="highlighter-rouge">CF_GOOGLE_REGISTRY_HOST</code>.</li></ul>{:/}| Optional |
123+
|`CF_DOCKERHUB_USERNAME`| Relevant only to provide explicit credentials to the Docker Hub container registry where the image is stored. <br>The username for the Docker Hub container registry.<br><br>To use a Docker Hub container registry integration created in Codefresh, set`CF_CONTAINER_REGISTRY_INTEGRATION` instead.| Optional|
124+
|`CF_DOCKERHUB_PASSWORD`| Relevant only if`CF_DOCKERHUB_USERNAME` is specified.<br>The password for the Docker Hub container registry.| Optional|
125+
|`CF_REGISTRY_USERNAME`| Relevant for container registries that support[Docker Registry Protocol v2](https://docs.docker.com/registry/spec/api/){:target="\_blank"}. <br>The username for the Docker Registry Protocol v2 container registry. <br><br>To use a container registry integration created in Codefresh, set`CF_CONTAINER_REGISTRY_INTEGRATION` instead.| Optional|
126+
|`CF_REGISTRY_PASSWORD`| Relevant only if`CF_REGISTRY_USERNAME` is specified.<br> The password for the Docker Registry Protocol v2 container registry.| Optional|
127+
|`CF_REGISTRY_DOMAIN`| Relevant only if`CF_REGISTRY_USERNAME` and`CF_REGISTRY_PASSWORD` are specified. <br> The domain for the Docker Registry Protocol v2 container registry.| Optional|
128+
|`CF_GOOGLE_JSON_KEY`| Relevant only for Google Artifact Registry (GAR) or Google Container Registry (GCR).<br> The Google Cloud Platform Service Account key in JSON format to authenticate to GAR or GCR.| Optional|
129+
|`CF_GOOGLE_REGISTRY_HOST`| Relevant only if`CF_GOOGLE_JSON_KEY` is specified.<br>The GAR or GCR host. <br>For example,`us-central1-docker.pkg.dev` or`gcr.io`.| Optional|
123130
|`CF_JIRA_INTEGRATION` | Deprecated from version 0.0.565. Replaced by`CF_ISSUE_TRACKING_INTEGRATION`. |_Deprecated_
124131
|`CF_ISSUE_TRACKING_INTEGRATION`| The name of the issue tracking integration created in Codefresh to use to enrich the image. Relevant only if Jira enrichment is required for the image. If you don't have a Jira integration, click**Create Atlassian Jira Integration** and configure settings. See[Jira integration]({{site.baseurl}}/docs/gitops-integrations/issue-tracking/jira/).| Optional|
125132
|`CF_IMAGE`| The image to be enriched and reported in Codefresh. Pass the`[account-name]/[image-name]:[tag]` built in your CI.| Required|

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp