Skip to content

Commit

Permalink
docs: updated target platform (#2857)
Browse files Browse the repository at this point in the history
* updated target platform

* updated target platform

* minor updates on container registries
  • Loading branch information
SNe789 authored Jan 24, 2023
1 parent c3c1407 commit 2249fb2
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
32 changes: 18 additions & 14 deletions docs/user-guide/creating-application/container-registry-override.md
Original file line number Diff line number Diff line change
@@ -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.

14 changes: 7 additions & 7 deletions docs/user-guide/global-configurations/docker-registries.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <namespace> secret docker-registry regcred --docker-server=<your-registry-server> --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
```

where:
* <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.
* `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`.

Expand Down

0 comments on commit 2249fb2

Please sign in to comment.