From 2249fb29f5b297021ec002a868710b62d021f45d Mon Sep 17 00:00:00 2001 From: SNe789 <113748500+SNe789@users.noreply.github.com> Date: Tue, 24 Jan 2023 14:46:46 +0530 Subject: [PATCH] docs: updated target platform (#2857) * updated target platform * updated target platform * minor updates on container registries --- docs/SUMMARY.md | 2 +- .../container-registry-override.md | 32 +++++++++++-------- .../docker-registries.md | 14 ++++---- 3 files changed, 26 insertions(+), 22 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 397e2723ef..cd73cca246 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -54,7 +54,7 @@ * [Workflow Overview](user-guide/creating-application/workflow/README.md) * [CI Pipeline](user-guide/creating-application/workflow/ci-pipeline.md) * [Pre-Build/Post-Build Tasks](user-guide/creating-application/workflow/ci-build-pre-post-plugins.md) - * [Override Container Registry and Dockerfile](user-guide/creating-application/container-registry-override.md) + * [Override Build Configuration](user-guide/creating-application/container-registry-override.md) * [CI Pipeline (Legacy)](user-guide/creating-application/workflow/ci-pipeline-legacy.md) * [CD Pipeline](user-guide/creating-application/workflow/cd-pipeline.md) * [Config Maps](user-guide/creating-application/config-maps.md) diff --git a/docs/user-guide/creating-application/container-registry-override.md b/docs/user-guide/creating-application/container-registry-override.md index 197aba2e7f..de4a3a17e1 100644 --- a/docs/user-guide/creating-application/container-registry-override.md +++ b/docs/user-guide/creating-application/container-registry-override.md @@ -1,22 +1,26 @@ -# Override Container Registry and Container Image +# Override Build Configuration -Within the same application, you can override a `Container registry` and `Container image` during the build pipeline, which means the images built for non-production environment can be included to the non-production registry and the images for production environment can be included to the production registry. +Within the same application, you can override a `container registry`, `container image` and `target platform` during the build pipeline, which means the images built for non-production environment can be included to the non-production registry and the images for production environment can be included to the production registry. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/override-container-registry-image.png) -To override a container registry and container image: -1. Open the build pipeline of your application. -2. Click **Allow Override** to select the new container registry and also to create and build the new container image. -3. On **Store container image** section: +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/select-build-override.jpg) -| Fields | Description | -| --- | --- | -| **Container Registry** | Select the container registry from the drop-down list. | -| **Container Repository** | Enter the name of the container repository. | +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/build-allow-override.jpg) -To create and build a new container image with different options, refer [build the container image](https://docs.devtron.ai/usage/applications/creating-application/docker-build-configuration#build-the-container-image) section. +To override a container registry, container image or target paltform: -4. **Update Pipeline**. +* Go to **Applications** and select your application from the **Devtron Apps** tabs. +* On the **App Configuration** tab, select **Workflow Editor**. +* Open the build pipeline of your application. +* Click **Allow Override** to: + * Select the new container registry from the drop-down list. + * Or, [create and build the new container image](https://docs.devtron.ai/usage/applications/creating-application/docker-build-configuration#build-the-container-image) with different options. + * Or, set a [new target platform](https://docs.devtron.ai/usage/applications/creating-application/docker-build-configuration#set-target-platform-for-the-build) from the drop-down list or enter a new target platform. + +* Click **Update Pipeline**. + +The overriden container registry/container image location/target platform will be reflected on the [Build Configuration](docker-build-configuration.md) page. You can also see the number of build pipelines for which the container registry/container image location/target platform is overriden. + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/build-configuration-overridden.jpg) -The overriden container registry / container image location will be reflected on the [Build Configuration](docker-build-configuration.md) page. You can also see the number of build pipelines for which the container registry / container image location is overriden. diff --git a/docs/user-guide/global-configurations/docker-registries.md b/docs/user-guide/global-configurations/docker-registries.md index 9eb03f3547..1d8c99ae14 100644 --- a/docs/user-guide/global-configurations/docker-registries.md +++ b/docs/user-guide/global-configurations/docker-registries.md @@ -170,7 +170,7 @@ There are two options to manage the access of registry credentials: You can choose one of the two options for defining credentials: -* [User Registry Credentials](#use-registry-credentials) +* [Use Registry Credentials](#use-registry-credentials) * [Specify Image Pull Secret](#specify-image-pull-secret) ### Use Registry Credentials @@ -187,18 +187,18 @@ You can create a Secret by providing credentials on the command line. ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/container-registries/specify-image-pull-secret-latest.png) -Create this Secret, naming it `regcred`: +Create this Secret naming it `regcred` (as an example): ```bash kubectl create -n secret docker-registry regcred --docker-server= --docker-username= --docker-password= --docker-email= ``` where: -* is your virtual cluster. E.g., devtron-demo -* is your Private Docker Registry FQDN. Use https://index.docker.io/v1/ for DockerHub. -* is your Docker username. -* is your Docker password. -* is your Docker email. +* `namespace` is your virtual cluster. E.g., devtron-demo +* `your-registry-server` is your Private Docker Registry FQDN. Use https://index.docker.io/v1/ for DockerHub. +* `your-name` is your Docker username. +* `your-pword` is your Docker password. +* `your-email` is your Docker email. You have successfully set your Docker credentials in the cluster as a Secret called `regcred`.