Skip to content

Commit

Permalink
doc: Link corrections and Fixes (#4733)
Browse files Browse the repository at this point in the history
* Fixed incorrect links

* Fixed typo in internal link for blob storage

* DevOps Team Suggestion + Other Fixes
  • Loading branch information
ashokdevtron authored Mar 4, 2024
1 parent 0fc75ed commit df3caad
Show file tree
Hide file tree
Showing 11 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/setup/install/install-devtron-with-cicd-with-gitops.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ helm install devtron devtron/devtron-operator \
--set argo-cd.enabled=true
```

**Note**: If you want to configure Blob Storage during the installation, refer [configure blob storage duing installation](#configure-blob-storage-duing-installation).
**Note**: If you want to configure Blob Storage during the installation, refer [configure blob storage duing installation](#configure-blob-storage-during-installation).


## Install Multi-Architecture Nodes (ARM and AMD)
Expand All @@ -35,7 +35,7 @@ To install Devtron on clusters with the multi-architecture nodes (ARM and AMD),
* If you want to install Devtron for `production deployments`, please refer to our recommended overrides for [Devtron Installation](override-default-devtron-installation-configs.md).


## Configure Blob Storage duing Installation
## Configure Blob Storage during Installation

Configuring Blob Storage in your Devtron environment allows you to store build logs and cache.
In case, if you do not configure the Blob Storage, then:
Expand Down
2 changes: 1 addition & 1 deletion docs/setup/install/install-devtron-with-cicd.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ helm install devtron devtron/devtron-operator \
```

{% hint style="info" %}
If you want to configure Blob Storage during the installation, refer [configure blob storage duing installation](#configure-blob-storage-duing-installation).
If you want to configure Blob Storage during the installation, refer [configure blob storage duing installation](#configure-blob-storage-during-installation).
{% endhint %}

---
Expand Down
2 changes: 1 addition & 1 deletion docs/setup/install/installation-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Configure the following properties:
| :--- | :--- | :--- |
| **BASE\_URL\_SCHEME** | Either of HTTP or HTTPS \(required\) | HTTP |
| **BASE\_URL** | URL without scheme and trailing slash, this is the domain pointing to the cluster on which the Devtron platform is being installed. For example, if you have directed domain `devtron.example.com` to the cluster and the ingress controller is listening on port `32080` then URL will be `devtron.example.com:32080` \(required\) | `change-me` |
| **DEX\_CONFIG** | dex config if you want to integrate login with SSO \(optional\) for more information check [Argocd documentation](https://argoproj.github.io/argo-cd/operator-manual/user-management/) | NA |
| **DEX\_CONFIG** | dex config if you want to integrate login with SSO \(optional\) for more information check [Argocd documentation](https://argo-cd.readthedocs.io/en/stable/operator-manual/user-management/) | NA |
| **EXTERNAL\_SECRET\_AMAZON\_REGION** | AWS region for the secret manager to pick \(required\) | NA |
| **PROMETHEUS\_URL** | URL of Prometheus where all cluster data is stored; if this is wrong, you will not be able to see application metrics like CPU, RAM, HTTP status code, latency, and throughput \(required\) | NA |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1100,11 +1100,11 @@ If you want to see application metrics like different HTTP status codes metrics,

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/deployment-template/deployment_application_metrics.jpg)

Once all the Deployment template configurations are done, click on `Save` to save your deployment configuration. Now you are ready to create [Workflow](workflow/) to do CI/CD.
Once all the Deployment template configurations are done, click on `Save` to save your deployment configuration. Now you are ready to create [Workflow](../workflow/README.md) to do CI/CD.

### Helm Chart Json Schema

Helm Chart [json schema](../../../scripts/devtron-reference-helm-charts/reference-chart_4-11-0/schema.json) is used to validate the deployment template values.
Helm Chart [json schema](../../../../scripts/devtron-reference-helm-charts/reference-chart_4-11-0/schema.json) is used to validate the deployment template values.

### Other Validations in Json Schema

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -971,11 +971,11 @@ If you want to see application metrics like different HTTP status codes metrics,

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/deployment-template/deployment_application_metrics.jpg)

Once all the Deployment template configurations are done, click on `Save` to save your deployment configuration. Now you are ready to create [Workflow](workflow/) to do CI/CD.
Once all the Deployment template configurations are done, click on `Save` to save your deployment configuration. Now you are ready to create [Workflow](../workflow/README.md) to do CI/CD.

### Helm Chart Json Schema

Helm Chart [json schema](../../../scripts/devtron-reference-helm-charts/reference-chart_4-11-0/schema.json) is used to validate the deployment template values.
Helm Chart [json schema](../../../../scripts/devtron-reference-helm-charts/reference-chart_4-11-0/schema.json) is used to validate the deployment template values.

### Other Validations in Json Schema

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You can create a task either by selecting one of the available preset plugins or

| Stage | Task |
| :--- | :--- |
| Pre-Build/Post-Build | <ol><li>Create a task using one of the [Preset Plugins](#preset-plugins) integrated in Devtron:<ul><li>[K6 Load testing](#k6-load-testing)</li><li>[Sonarqube](#sonarqube)</li><li>[Dependency track for Python](#dependency-track-for-python)</li><li>[Dependency track for NodeJs](#dependency-track-for-nodejs)</li><li>[Dependency track for Maven and Gradle](#dependency-track-for-maven--gradle)</li><li>[Semgrep](#semgrep)</li><li>[Codacy](#codacy)</li></ul></li><li>Create a task from [Execute Custom script](#execute-custom-script) which you can customize your script with:<ul><li>[Custom script - Shell](#custom-script-shell)</li><li>Or, [Custom script - Container image](#custom-script-container-image)</li></ul></li></ol> |
| Pre-Build/Post-Build | <ol><li>Create a task using one of the [Preset Plugins](#preset-plugins) integrated in Devtron:<ul><li>[K6 Load testing](../../plugins/k6-load-testing.md)</li><li>[Sonarqube](../../plugins/sonarqube.md)</li><li>[Dependency track for Python](../../plugins/dependency-track-python.md)</li><li>[Dependency track for NodeJs](#dependency-track-for-nodejs)</li><li>[Dependency track for Maven and Gradle](../../plugins/dependency-track-maven-gradle.md)</li><li>[Semgrep](../../plugins/semgrep.md)</li><li>[Codacy](../../plugins/codacy.md)</li></ul></li><li>Create a task from [Execute Custom script](#execute-custom-script) which you can customize your script with:<ul><li>[Custom script - Shell](#custom-script-shell)</li><li>Or, [Custom script - Container image](#custom-script-container-image)</li></ul></li></ol> |


## Creating Pre/Post-build Tasks
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/creating-application/workflow/ci-pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ You can use Devtron for deployments on Kubernetes while using an external CI too

| Fields | Description |
| --- | --- |
| **Deploy to environment** | <ul><li>`Environment`: Provide the name of the [environment](../../global-configurations/cluster-and-environments#add-environment).</ul></li><ul><li>`Namespace`: Provide the [namespace](../../global-configurations/cluster-and-environments#add-environment).</ul></li> |
| **Deploy to environment** | <ul><li>`Environment`: Provide the name of the [environment](../../global-configurations/cluster-and-environments.md#add-environment).</ul></li><ul><li>`Namespace`: Provide the [namespace](../../global-configurations/cluster-and-environments.md#add-environment).</ul></li> |
| **When do you want to deploy** | You can deploy either in one of the following ways: <ul><li>`Automatic`: If you select automatic, your application will be deployed automatically everytime a new image is received.</ul></li> <ul><li>`Manual`: In case of manual, you have to select the image and deploy manually. </ul></li>|
| **Deployment Strategy** | Configure the deployment preferences for this pipeline. |

Expand All @@ -255,7 +255,7 @@ To get the webhook URL and JSON sample payload to be used in external CI pipelin
* On the **Webhook Details** page, you have to authenticate via `API token` to allow requests from an external service (e.g. Jenkins or CircleCI).

* For authentication, only users with `super-admin` permissions can select or generate an API token:
* You can either use **Select API Token** if you have generated an [API Token](../../global-configurations/authorization/api-tokens) under **Global Configurations**.
* You can either use **Select API Token** if you have generated an [API Token](../../global-configurations/authorization/api-tokens.md) under **Global Configurations**.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/webhook-ci/select-api-token-webhook-details-v2.jpg)

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/deploying-application/triggering-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If no approved images are available or the current image is already deployed, yo

### Requesting for Image Approval

Users need to have [Build & deploy permission](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and application) to request for an image approval.
Users need to have [Build & deploy permission](../global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and application) to request for an image approval.

To request an image approval, follow these steps:

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/global-configurations/custom-charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ You can use the following variables in the helm template (all the placeholders a
"deploymentType": "{{.DeploymentType}}",
"app": "{{.App}}",
"env": "{{.Env}}",
"appMetrics": "{{.AppMetrics}}"
"appMetrics": {{.AppMetrics}}
}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Preset plugins are micro tools that allow you to enhance and refine the [CI/CD w

Unlike [custom scripts](../creating-application/workflow/ci-build-pre-post-plugins.md#execute-custom-script), preset plugins come bundled with specific variables and conditions that help you make the plugins work seamlessly with your CI/CD pipeline.

Some plugins are meant for pre-build/post-build, while some are meant for pre-deployement/post-deployement.
Some plugins are meant for pre-build/post-build, while some are meant for pre-deployment/post-deployment.

From this section, you can know more about the individual plugins and its purpose.

10 changes: 5 additions & 5 deletions docs/user-guide/plugins/copy-container-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

Building container images in CI often results in a growing number of images, not all of which are production-ready. Therefore, it's a best practice to maintain a separate repository exclusively for storing production-builds. However, this would involve copying the container image (production-ready) from your existing repository to the production repository.

This plugin helps you copy a container image to a desired container [repository](../../../../reference/glossary.md#repo). The pushing of image can be between repositories of the same container [registry](../../../../reference/glossary.md#containeroci-registry) or between repositories of different container registry. One of the major usecases this plugin serves is multi-cloud deployments.
This plugin helps you copy a container image to a desired container [repository](../../reference/glossary.md#repo). The pushing of image can be between repositories of the same container [registry](../../reference/glossary.md#containeroci-registry) or between repositories of different container registry. One of the major usecases this plugin serves is multi-cloud deployments.

The plugin can be used at post CI, pre-CD, and post-CD. Moreover, you can also [customize the image tag pattern](../cd-pipeline.md#custom-image-tag-pattern) for the copied image.
The plugin can be used at post CI, pre-CD, and post-CD. Moreover, you can also [customize the image tag pattern](../creating-application/workflow/cd-pipeline.md#custom-image-tag-pattern) for the copied image.

## Steps to Use

Expand All @@ -28,7 +28,7 @@ The plugin can be used at post CI, pre-CD, and post-CD. Moreover, you can also [

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/image-destination.jpg)

* **registry-name** is the name you gave to your container registry while adding it in [Global Configuration → OCI/Container Registry](../../../global-configurations/container-registries.md#add-container-registry).
* **registry-name** is the name you gave to your container registry while adding it in [Global Configuration → OCI/Container Registry](../global-configurations/container-registries.md#add-container-registry).

* **user-name** is the your account name registered with you container registry, e.g., DockerHub.

Expand All @@ -44,7 +44,7 @@ The plugin can be used at post CI, pre-CD, and post-CD. Moreover, you can also [

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/trigger-pre-cd.jpg)

9. The copying process will initiate, and once it is successful, the [tag for the copied image](../cd-pipeline.md#custom-image-tag-pattern) would reflect at all relevant screens:
9. The copying process will initiate, and once it is successful, the [tag for the copied image](../creating-application/workflow/cd-pipeline.md#custom-image-tag-pattern) would reflect at all relevant screens:

* **Destination Repository**

Expand All @@ -57,7 +57,7 @@ The plugin can be used at post CI, pre-CD, and post-CD. Moreover, you can also [
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/prod-image.jpg)

{% hint style="info" %}
You can also filter out specific images (of target repository) from deployment. Refer [Filter Condition](../../../global-configurations/filter-condition.md) to know the process.
You can also filter out specific images (of target repository) from deployment. Refer [Filter Condition](../global-configurations/filter-condition.md) to know the process.
{% endhint %}


Expand Down

0 comments on commit df3caad

Please sign in to comment.