From 050e4b40977ed59620ec8cd4868b45a40a1d06d1 Mon Sep 17 00:00:00 2001 From: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com> Date: Fri, 21 Jun 2024 18:29:25 +0530 Subject: [PATCH] docs: Fixes + Corrections in Docs (#5335) * Fixes + Corrections in Docs * PM Feedback Incorporated --- docs/FAQs/devtron-troubleshoot.md | 2 +- docs/SUMMARY.md | 1 - docs/reference/glossary.md | 6 +- .../environment-overrides.md | 15 +- .../creating-application/gitops-config.md | 20 +- .../workflow/ci-pipeline-legacy.md | 244 ------------------ .../workflow/ci-pipeline.md | 2 +- .../global-configurations/git-accounts.md | 2 +- .../global-configurations/gitops.md | 38 +-- docs/user-guide/jobs/workflow-editor-job.md | 2 +- 10 files changed, 48 insertions(+), 284 deletions(-) delete mode 100644 docs/user-guide/creating-application/workflow/ci-pipeline-legacy.md diff --git a/docs/FAQs/devtron-troubleshoot.md b/docs/FAQs/devtron-troubleshoot.md index 6133779ce41..eedcbb2e429 100644 --- a/docs/FAQs/devtron-troubleshoot.md +++ b/docs/FAQs/devtron-troubleshoot.md @@ -20,7 +20,7 @@ kubectl get pods -n devtroncd kubectl delete jobs -n devtroncd ``` -- Now download `migrator.yaml` file from our github repository using the command: +- Now download `migrator.yaml` file from our GitHub repository using the command: ```bash wget https://raw.githubusercontent.com/devtron-labs/devtron/main/manifests/yamls/migrator.yaml ``` diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 7f1a928e246..4844d6fe807 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -76,7 +76,6 @@ * [CI Pipeline](user-guide/creating-application/workflow/ci-pipeline.md) * [Pre-Build/Post-Build Stages](user-guide/creating-application/workflow/ci-build-pre-post-plugins.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) * [ConfigMaps](user-guide/creating-application/config-maps.md) * [Secrets](user-guide/creating-application/secrets.md) diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index f5b76df83da..69402187cba 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -98,7 +98,7 @@ However, in case you don't have a Dockerfile, Devtron helps you create one. Go t Evacuating pods from a node before cordoning it, ensuring that running pods are gracefully rescheduled on other nodes. -In Devtron, you can drain a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Drain (available in blue). [Read More...](../user-guide/clusters.md#drain-a-node) +In Devtron, you can drain a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Drain (available in blue). [Read More...](../user-guide/resource-browser.md#drain-a-node) ### Environment @@ -164,7 +164,7 @@ In Devtron, you can view a list of namespaces by going to Resource Browser → ( A setting applied to a node that influences the scheduling of pods. Taints can restrict which pods are allowed to run on the node. -In Devtron, you can edit the taints of a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Edit taints (available in blue). [Read More...](../user-guide/clusters.md#taint-a-node) +In Devtron, you can edit the taints of a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Edit taints (available in blue). [Read More...](../user-guide/resource-browser.md#taint-a-node) ### NodePort @@ -174,7 +174,7 @@ A Kubernetes service type that exposes a port on each node in the cluster, makin The physical or virtual machines that make up a Kubernetes cluster, where containers are scheduled to run. -In Devtron, you can view nodes by going to Resource Browser → (choose a cluster) → Nodes. [Read More...](../user-guide/clusters.md#nodes) +In Devtron, you can view nodes by going to Resource Browser → (choose a cluster) → Nodes. [Read More...](../user-guide/resource-browser.md#nodes) ### Objects diff --git a/docs/user-guide/creating-application/environment-overrides.md b/docs/user-guide/creating-application/environment-overrides.md index 539c5a1d2d1..d4417b358a0 100644 --- a/docs/user-guide/creating-application/environment-overrides.md +++ b/docs/user-guide/creating-application/environment-overrides.md @@ -2,7 +2,7 @@ You will see all your environments associated with an application under the `Environment Overrides` section. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/environment-override.jpg) +![Figure 1: App Configuration → Environment Overrides](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/environment-override-v2.jpg) You can customize your `Deployment template, ConfigMap, Secrets` in Environment Overrides section to add separate customizations for different environments such as dev, test, integration, prod, etc. @@ -50,9 +50,16 @@ The same goes for `ConfigMap` and `Secrets`. You can also create an environment- If you want to configure your ConfigMap and secrets at the application level then you can provide them in [ConfigMaps](config-maps.md) and [Secrets](secrets.md), but if you want to have environment-specific ConfigMap and secrets then provide them under the Environment override Section. At the time of deployment, it will pick both of them and provide them inside your cluster. -Click on `Update ConfigMap` to update Configmaps. +To update a ConfigMap, follow the steps below: +1. In your environment, click **ConfigMaps**. +2. Click the ConfigMap you wish to update. +3. Click **Allow Override**. +4. Edit your ConfigMap. +5. Click **Save Changes**. -Click on `Update Secrets` to update Secrets. +![Figure 2: Updating ConfigMap](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/update-configmap.gif) -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/arora4.gif) +Similarly, you can update Secrets too as shown below. + +![Figure 3: Updating Secret](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/update-secret.gif) diff --git a/docs/user-guide/creating-application/gitops-config.md b/docs/user-guide/creating-application/gitops-config.md index a459c36b2ba..362bd4f62c2 100644 --- a/docs/user-guide/creating-application/gitops-config.md +++ b/docs/user-guide/creating-application/gitops-config.md @@ -42,7 +42,7 @@ GitOps repositories, whether auto-created by Devtron or added manually, are immu ![Figure 3: Saved GitOps Config](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/saved-config.jpg) -**Note**: In case you skipped the GitOps configuration for your application and proceeded towards the [creation of a new CD pipeline](../creating-application/workflow/cd-pipeline.md#creating-cd-pipeline)(that uses GitOps), you will be prompted to configure GitOps as shown below: +**Note**: In case you skipped the GitOps configuration for your application and proceeded towards the [creation of a new CD pipeline](../creating-application/workflow/cd-pipeline.md#creating-cd-pipeline) (that uses GitOps), you will be prompted to configure GitOps as shown below: ![Figure 4: Incomplete GitOps Config](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/gitops-not-configured.jpg) @@ -59,23 +59,25 @@ You can [deploy a helm chart](../deploy-chart/overview-of-charts.md#deploying-ch ![Figure 6: Configure & Deploy Button](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/configure-deploy.jpg) -3. After you enter the `App Name`, `Project`, and `Environment`; an option to choose the deployment approach (i.e., Helm or GitOps) would appear. +3. After you enter the `App Name`, `Project`, and `Environment`; an option to choose the deployment approach (i.e., Helm or GitOps) would appear. Select **GitOps**. - ![Figure 7: Deployment Approach](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/deployment-method.jpg) +{% hint style="info" %} +The option to choose between 'Helm' or 'GitOps' is only available in +{% endhint %} -4. Select **GitOps**. +![Figure 7a: Deployment Approach](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/deployment-method.jpg) - ![Figure 8: Selecting GitOps Method](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/select-gitops.jpg) +![Figure 7b: Selecting GitOps Method](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/select-gitops.jpg) -5. A modal window will appear for you to enter a Git repository. Just like [Devtron Apps](#for-devtron-apps) (step 2), you get two options: +4. A modal window will appear for you to enter a Git repository. Just like [Devtron Apps](#for-devtron-apps) (step 2), you get two options: * Auto-create repository * Commit manifests to a desired repository - ![Figure 9: Adding a Repo](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/git-repository-helm-app.jpg) + ![Figure 8: Adding a Repo](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/git-repository-helm-app.jpg) -6. Enter your custom Git Repo URL, and click **Save**. +5. Enter your custom Git Repo URL, and click **Save**. - ![Figure 10: Saved GitOps Config for Helm App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/custom-git-repo-helm-apps.jpg) + ![Figure 9: Saved GitOps Config for Helm App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/custom-git-repo-helm-apps.jpg) Next, you may proceed to deploy the chart. diff --git a/docs/user-guide/creating-application/workflow/ci-pipeline-legacy.md b/docs/user-guide/creating-application/workflow/ci-pipeline-legacy.md deleted file mode 100644 index ab1bf880e77..00000000000 --- a/docs/user-guide/creating-application/workflow/ci-pipeline-legacy.md +++ /dev/null @@ -1,244 +0,0 @@ -# CI Pipeline (Legacy) - -CI Pipeline can be created in three different ways, [`Continuous Integration`](#a.-continuous-integration), [`Linked CI Pipeline`](#b.-linked-ci-pipeline) and [`Incoming Webhook`](#c.-incoming-webhook). - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/workflow-ci.jpg) - -Each of these methods have different use-cases which can be used according to the needs of the organization. Let’s begin with Continuous Integration. - -## A. Continuous Integration - -Click on Continuous Integration, a prompt comes up in which we need to provide our custom configurations. Below is the description of some configurations which are required. - -| Key | Description | -| :--- | :--- | -| `Pipeline Name` | Name of the pipeline | -| `Pipeline Execution (Advanced)` | Select from automatic or manual execution depending upon your use-case | -| `Source Type` | Select the source through which the CI Pipeline will be triggered | -| `Stages (Advanced)` | 1.**Pre-build Stages**- Scripts to be executed before building an image. 2.**Docker build Stages**- Provide a new argument and override an old argument in key-value pair. 3. **Post-build Stages**- Scripts to be executed after building image | -| `Scan for vulnerabilities (Advanced)` | It will scan your image and find if any vulnerabilities present | - - -[Note] Options such as pipeline execution, stages and scan for vulnerabilities, will be visible after clicking on advanced options present in the bottom left corner. - -### I. Pipeline Name -Pipeline name is an auto-generated name which can also be renamed by clicking on Advanced options. - -### II. Pipeline Execution -You can select the method you want to execute the pipeline. By default the value is automatic. In this case it will get automatically triggered if any changes are made to the respective git repository. You can set it to manual if you want to trigger the pipeline manually. - -### III. Source Type -In source type, we can observe that we have three types of mechanisms which can be used for building your CI Pipeline. In the drop-down you can observe we have Branch Fixed, Pull Request and Tag Creation. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ci-pipeline-2.jpg) - -#### i) Branch Fixed -If you select the Branch Fixed as your source type for building CI Pipeline, then you need to provide the corresponding Branch Name. - -Branch Name is the name of the corresponding branch (eg. main or master, or any other branch) - -#### ii) Pull Request -[Note] It only works if Git Host is Github or Bitbucket Cloud as of now. In case you need support for any other Git Host, please create a [github issue](https://github.com/devtron-labs/devtron/issues). - -If you select the Pull Request option, you can configure the CI Pipeline using the generated PR. For this mechanism you need to configure a webhook for the repository added in the Git Material. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ci-pipeline-3.jpg) - -##### Prerequisites for Pull Request -**If using GitHub -** -To use this mechanism, as stated above you need to create a webhook for the corresponding repository of your Git Provider. In Github to create a webhook for the repository - - -1. Go to settings of that particular repository -2. Click on webhook section under options tab -3. In the Payload URL section, please copy paste the Webhook URL which can be found at Devtron Dashboard when you select source type as Pull Request as seen in above image. -4. Change content type to - application/json -5. Copy paste the Secret as well from the Dashboard when you select the source type as Pull Request - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ci-pipeline-4.jpg) - -Now, scroll down and select the custom events for which you want to trigger the webhook to build CI Pipeline - - -6. Check the radio button for **Let me select individual events** -7. Then, check the Branch or **Tag Creation** and **Pull Request** radio buttons under the individual events as mentioned in image below. - -[Note] If you select **Branch or Tag Creation**, it will work for the **Tag Creation** mechanism as well. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ci-pipeline-5.jpg) - -After selecting the respective options, click on the generate the webhook button to create a webhook for your respective repository. - -**If using Bitbucket Cloud -** -If you are using Bitbucket cloud as your git provider, you need to create a webhook for that as we created for Github in the above section. Follow the steps to create webhook - - -1. Go to Repository Settings on left sidebar of repository window -2. Click on Webhooks and then click on Add webhook as shown in the image. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ci-pipeline-6.jpg) - -3. Give any appropriate title as per your choice and then copy-paste the url which you can get from Devtron Dashboard when you select Pull Request as source type in case of Bitbucket Cloud as Git Host. -4. Check the Pull Request events for which you want to trigger the webhook and then save the configurations. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ci-pipeline-7.jpg) - -##### Filters -Now, coming back to the Pull Request mechanism, you can observe we have the option to add filters. In a single repository we have multiple PRs generated, so to have the exact PR for which you want to build the CI Pipeline, we have this feature of filters. - -You can add a few filters which can be seen in the dropdown to sort the exact PR which you want to use for building the pipeline. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ci-pipeline-8.jpg) - -Below are the details of different filters which you can use as per your requirement. Please select any of the filters and pass the value in regex format as one has already given for example and then click on **Create Pipeline**. - -Devtron uses regexp library, view [regexp cheatsheet](https://yourbasic.org/golang/regexp-cheat-sheet/). You can test your custom regex from [here](https://regex101.com/r/lHHuaE/1). - -| Key | Description | -| :--- | :--- | -| `Source branch name` | Branch from which the Pull Request is generated. | -| `Target branch name` | Branch to which the Pull request will be merged. | -| `Author` | The one who created the Pull Request. | -| `Title` | Title provided to the Pull Request. | -| `State` | It shows the state of PR and as of now it is fixed to Open which cannot be changed. | - -#### iii) Tag Creation -The third option i.e, **Tag Creation**. In this mechanism you need to provide the tag name or author to specify the exact tag for which you want to build the CI Pipeline. To work with this feature as well, you need to configure the webhook for either Github or Bitbucket as we did in the previous mechanism i.e, **Pull Request**. - -In this process as well you can find the option to filter the specific tags with certain filter parameters. Select the appropriate filter as per your requirement and pass the value in form of regex, one of the examples is already given. - -| Filter | Description | -| :--- | :--- | -| `Author` | The one who created the tag. | -| `Tag name` | Name of the tag for which the webhook will be triggered. | - -Select the appropriate filter and pass the value in the form of regex and then click on **Create Pipeline**. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ci-pipeline-9.jpg) - -### Advanced Options -When you click on the advanced options button which can be seen at the bottom-left of the screen, you can see some more configuration options which includes pipeline execution, stages and scan for vulnerabilities. - -#### Stages: -There are 3 dropdowns given below: - -* **Pre-build** -* **Docker build** -* **Post-build** - -**\(a\) Pre-build** - -This section is used for those steps which you want to execute before building the Docker image. To add a `Pre-build stage`, click on `Add Stage` and provide a name to your pre-stage and write your script as per your requirement. These stages will run in sequence before the docker image is built. Optionally, you can also provide the path of the directory where the output of the script will be stored locally. - -You can add one or more than one stage in a CI Pipeline. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/pre_build.jpg) - -**\(b\) Docker build** - -Though we have the option available in the `Docker build configuration` section to add arguments in key-value pairs for the docker build image. But one can also provide docker build arguments here as well. This is useful, in case you want to override them or want to add new arguments to build your docker image. - -**\(c\) Post-build** - -The post-build stage is similar to the pre-build stage. The difference between the post-build stage and the pre-build stage is that the post-build will run when your CI pipeline will be executed successfully. - -Adding a post-build stage is similar to adding a pre-build stage. Click on `Add Stage` and provide a name to your post-stage. Here you can write your script as per your requirement, which will run in sequence after the docker image is built. You can also provide the path of the directory in which the output of the script will be stored in the `Remote Directory` column. And this is optional to fill because many times you run scripts that do not provide any output. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/post_build.jpg) - -**NOTE:** - -**(a)** You can provide pre-build and post-build stages via the Devtron tool’s console or can also provide these details by creating a file `devtron-ci.yaml` inside your repository. There is a pre-defined format to write this file. And we will run these stages using this YAML file. -You can also provide some stages on the Devtron tool’s console and some stages in the devtron-ci.yaml file. But stages defined through the `Devtron` dashboard are first executed then the stages defined in the `devtron-ci.yaml` file. - -**(b)** The total timeout for the execution of the CI pipeline is by default set as 3600 seconds. This default timeout is configurable according to the use-case. The timeout can be edited in the configmap of the orchestrator service in the env variable `env:"DEFAULT_TIMEOUT" envDefault:"3600"` - -#### Scan for vulnerabilities - -`Scan for vulnerabilities` adds a security feature to your application. If you enable this option, your code will be scanned for any vulnerabilities present in your code. And you will be informed about these vulnerabilities. For more details please check doc - -You have provided all the details required to create a CI pipeline, now click on `Create Pipeline`. - -#### Update CI Pipeline - -You can also update any configuration of an already created CI Pipeline, except the pipeline name. The pipeline name can not be edited. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ci-pipeline-update.jpg) - -Click on your CI pipeline, to update your CI Pipeline. A window will be popped up with all the details of the current pipeline. - -![]() - -Make your changes and click on `Update Pipeline` at the bottom to update your Pipeline. - -#### Delete CI Pipeline - -You can only delete CI pipeline if you have no CD pipeline created in your workflow. - -To delete a CI pipeline, go to the `App Configurations` and then click on `Workflow` editor - -Click on `Delete Pipeline` at the bottom to delete the CD pipeline - -#### Automated Test suite integration in the CI step using devtron-ci.yaml - -Users can run the test case using the Devtron dashboard or by including the test cases in the devtron.ci.yaml file in the source git repository. For reference, check: [https://github.com/kumarnishant/getting-started-nodejs/blob/master/devtron-ci.yaml](https://github.com/kumarnishant/getting-started-nodejs/blob/master/devtron-ci.yaml) - -The test cases given in the script will run before the test cases given in the devtron.ci.yaml - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/yaml.jpg) - -| Field | Description | -| :--- | :--- | -| `version` | specify the version of yaml | -| `appliesTo` | applies the changes to a specified branch | -| `type` | branch type on which changes are to be applied, it can be **BRANCH\_FIXED** or **TAG\_PATTERN** | -| `value` | branch name on which changes are to be applied, it can take a value as the name of branch \(“master”\) or as a regular expression \("%d.%d.%d-rc"\) | -| `script` | A script which you want to execute, you can also execute the docker commands here | -| `beforeDockerBuildStages` | script to run before the docker build step | -| `afterDockerBuildStages` | script to run after the docker build step | -| `outputLocation` | The location where you want to see the output of the report of Test cases | - -## B. Linked CI Pipeline - -If one code is shared across multiple applications, `Linked CI Pipeline` can be used, and only one image will be built for multiple applications because if there is only one build, it is not advisable to create multiple CI Pipelines. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ca-workflow-linked.jpg) - -To create a `Linked CI Pipeline`, please follow the steps mentioned below : - -1. Click on `+ New Build Pipeline` button. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/linked-ci-pipeline-1.png) - -2. Select `Linked CI Pipeline`. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/linked-ci-pipeline-2.png) - -3. Select the application in which the source CI pipeline is present. - -4. Select the source CI pipeline. - -5. Provide a name for linked CI pipeline. - -6. Click on `Create Linked CI Pipeline` button to create linked CI pipeline. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/linked-ci-pipeline-3.png) - -After creating a linked CI pipeline, you can create a CD pipeline. -You cannot trigger build from linked CI pipeline, it can be triggered only from source CI pipeline. Initially you will not see any images to deploy in CD pipeline created from `linked CI pipeline`. Trigger build in source CI pipeline to see the images in CD pipeline of linked CI pipeline. After this, whenever you trigger build in source CI pipeline, the build images will be listed in CD pipeline of `linked CI pipeline` too. - -## C. Incoming Webhook - -You can use Devtron for deployments on Kubernetes while using your own CI tool such as Jenkins. External CI features can be used for cases where the CI tool is hosted outside the Devtron platform. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ca-workflow-external.jpg) - -You can send the ‘Payload script’ to your CI tools such as Jenkins and Devtron will receive the build image every time the CI Service is triggered or you can use the Webhook URL which will build an image every time CI Service is triggered using Devtron Dashboard. - -| Key | Description | -| :--- | :--- | -| `Pipeline Name` | Name of the pipeline | -| `Source Type` | ‘Branch Fixed’ or ‘Tag Regex’ | -| `Branch Name` | Name of the branch | - - - - - diff --git a/docs/user-guide/creating-application/workflow/ci-pipeline.md b/docs/user-guide/creating-application/workflow/ci-pipeline.md index f372e690c9c..0346553385d 100644 --- a/docs/user-guide/creating-application/workflow/ci-pipeline.md +++ b/docs/user-guide/creating-application/workflow/ci-pipeline.md @@ -1,7 +1,7 @@ # CI Pipeline {% hint style="info" %} -For Devtron version older than v0.4.0, please refer the [CI Pipeline (legacy)](./ci-pipeline-legacy.md) page. +For Devtron version older than v0.4.0, please refer the [CI Pipeline (legacy)](https://docs.devtron.ai/v/v0.4/devtron/user-guide/creating-application/workflow/ci-pipeline-legacy) page. {% endhint %} ## Creating CI Pipeline diff --git a/docs/user-guide/global-configurations/git-accounts.md b/docs/user-guide/global-configurations/git-accounts.md index b851a1ae290..2d4b791d224 100644 --- a/docs/user-guide/global-configurations/git-accounts.md +++ b/docs/user-guide/global-configurations/git-accounts.md @@ -14,7 +14,7 @@ Provide the information in the following fields to add your git account: | :--- | :--- | | `Name` | Provide a name to your Git provider.
Note: This name will be available on the App Configuration > [Git repository](../creating-application/git-material.md) drop-down list.
| | `Git host` | It is the git provider on which corresponding application git repository is hosted.
Note: By default, `Bitbucket` and `GitHub` are available in the drop-down list. You can add many as you want by clicking `[+ Add Git Host]`.
| -| `URL` | Provide the Git host `URL`.
As an example: [https://github.com](https://github.com) for Github, [https://gitlab.com](https://gitlab.com) for GitLab etc. | +| `URL` | Provide the Git host `URL`.
As an example: [https://github.com](https://github.com) for GitHub, [https://gitlab.com](https://gitlab.com) for GitLab etc. | | `Authentication Type` | Devtron supports three types of authentications: | diff --git a/docs/user-guide/global-configurations/gitops.md b/docs/user-guide/global-configurations/gitops.md index bd26422bfe6..f8997ea0110 100644 --- a/docs/user-guide/global-configurations/gitops.md +++ b/docs/user-guide/global-configurations/gitops.md @@ -95,9 +95,9 @@ Fill the following mandatory fields: | Field | Description | | --- | --- | | **Git Host** | Shows the URL of GitHub, e.g., https://github.com/ | -| **GitHub Organisation Name** | Enter the GitHub organization name.
If you do not have one, refer [how to create organization in Github](#how-to-create-organization-in-github). | +| **GitHub Organisation Name** | Enter the GitHub organization name.
If you do not have one, refer [How to create organization in GitHub](#creating-organization-in-github). | | **GitHub Username** | Provide the username of your GitHub account | -| **Personal Access Token** | Provide your personal access token (PAT). It is used as an alternate password to authenticate your GitHub account.
If you do not have one, create a GitHub PAT [here](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).| +| **Personal Access Token** | Provide your personal access token (PAT). It is used as an alternate password to authenticate your GitHub account.
If you do not have one, create a GitHub PAT [here](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).

**Access Required**:
`repo` - Full control of private repositories (able to access commit status, deployment status, and public repositories).
`admin:org` - Full control of organizations and teams (Read and Write access). May not be required if you are using user-defined git repo.
`delete_repo` - Grants delete repo access on private repositories. | ### GitLab @@ -114,9 +114,9 @@ Fill the following mandatory fields: | Field | Description | | --- | --- | | **Git Host** | Shows the URL of GitLab, e.g., https://gitlab.com/ | -| **GitLab Group ID** | Enter the GitLab group ID.
If you do not have one, refer [GitLab Group ID](#how-to-create-organization-in-gitlab).| +| **GitLab Group ID** | Enter the GitLab group ID.
If you do not have one, refer [GitLab Group ID](#creating-group-in-gitlab).| | **GitLab Username** | Provide the username of your GitLab account | -| **Personal Access Token** | Provide your personal access token (PAT). It is used as an alternate password to authenticate your GitLab account.
If you do not have one, create a GitLab PAT [here](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html). | +| **Personal Access Token** | Provide your personal access token (PAT). It is used as an alternate password to authenticate your GitLab account.
If you do not have one, create a GitLab PAT [here](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html).

**Access Required**:
`api` - Grants complete read/write access to the scoped project API.
`write_repository` - Allows read/write access (pull, push) to the repository.| ### Azure @@ -133,9 +133,9 @@ Fill the following mandatory fields: | Field | Description | | --- | --- | | **Azure DevOps Organisation Url*** | Enter the Org URL of Azure DevOps. Format should be `https://dev.azure.com/`, where `` represents the organization name, e.g., [https://dev.azure.com/devtron-test](https://dev.azure.com/devtron-test)| -| **Azure DevOps Project Name** | Enter the Azure DevOps project name.
If you do not have one, refer [Azure DevOps Project Name](#how-to-create-azure-devops-project-name).| +| **Azure DevOps Project Name** | Enter the Azure DevOps project name.
If you do not have one, refer [Azure DevOps Project Name](#creating-project-in-azure-devops).| | **Azure DevOps Username*** | Provide the username of your Azure DevOps account | -| **Azure DevOps Access Token*** | Provide your Azure DevOps access token. It is used as an alternate password to authenticate your Azure DevOps account.
If you do not have one, create a Azure DevOps access token [here](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page). | +| **Azure DevOps Access Token*** | Provide your Azure DevOps access token. It is used as an alternate password to authenticate your Azure DevOps account.
If you do not have one, create a Azure DevOps access token [here](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page).

**Access Required**:
`code` - Grants the ability to read source code and metadata about commits, change sets, branches, and other version control artifacts. [More information on scopes in Azure DevOps](https://docs.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=azure-devops#scopes). | ### Bitbucket @@ -160,10 +160,10 @@ Fill the following mandatory fields: | Field | Description | | --- | --- | | **Bitbucket Host** | Shows the URL of Bitbucket Cloud, e.g., https://bitbucket.org/ | -| **Bitbucket Workspace ID** | Enter the Bitbucket workspace ID.
If you do not have one, refer [Bitbucket Workspace Id](#how-to-create-bitbucket-workspace-id)| +| **Bitbucket Workspace ID** | Enter the Bitbucket workspace ID.
If you do not have one, refer [Bitbucket Workspace ID](#creating-workspace-in-bitbucket)| | **Bitbucket Project Key** | Enter the Bitbucket project key.
If you do not have one, refer [Bitbucket Project Key](https://support.atlassian.com/bitbucket-cloud/docs/group-repositories-into-projects/).
Note: If the project is not provided, the repository is automatically assigned to the oldest project in the workspace. | | **Bitbucket Username*** | Provide the username of your Bitbucket account | -| **Personal Access Token** | Provide your personal access token (PAT). It is used as an alternate password to authenticate your Bitbucket Cloud account.
If you do not have one, create a Bitbucket Cloud PAT [here](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/). | +| **Personal Access Token** | Provide your personal access token (PAT). It is used as an alternate password to authenticate your Bitbucket Cloud account.
If you do not have one, create a Bitbucket Cloud PAT [here](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/).

**Access Required**:
`repo` - Full control of repositories (Read, Write, Admin, Delete) access. | #### Bitbucket Data Center @@ -210,12 +210,11 @@ We do **NOT** recommend using GitHub organization that contains your source code 7. Go to your profile and click **Your organizations** to view all the organizations you created. +{% hint style="info" %} +### Additional References For more information about the plans available for your team, see [GitHub's products](https://docs.github.com/en/get-started/learning-about-github/githubs-products). You can also refer [GitHub organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-organizations) official doc page for more detail. +{% endhint %} -**Note**: -* repo - Full control of private repositories (able to access commit status, deployment status, and public repositories). -* admin:org - Full control of organizations and teams (Read and write access). -* delete_repo - Grants delete repo access on private repositories. ### Creating Group in GitLab @@ -228,9 +227,6 @@ For more information about the plans available for your team, see [GitHub's prod 4. Enter the group name (required) and select the optional descriptions if required, and click **Create group**. 5. Your group will be created and your group name will be assigned with a new `Group ID` (e.g. 61512475). -**Note**: -* api - Grants complete read/write access to the scoped project API. -* write_repository - Allows read/write access (pull, push) to the repository. ### Creating Project in Azure DevOps @@ -246,10 +242,11 @@ For more information about the plans available for your team, see [GitHub's prod * Click **Create**. * Azure DevOps displays the project welcome page with the `project name`. +{% hint style="info" %} +### Additional References You can also refer [Azure DevOps - Project Creation](https://docs.microsoft.com/en-us/azure/devops/organizations/projects/create-project?view=azure-devops&tabs=preview-page) official page for more details. +{% endhint %} -**Note**: -* code - Grants the ability to read source code and metadata about commits, change sets, branches, and other version control artifacts. [More information on scopes in Azure DevOps](https://docs.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=azure-devops#scopes). ### Creating Workspace in Bitbucket @@ -265,7 +262,10 @@ You can also refer [Azure DevOps - Project Creation](https://docs.microsoft.com/ * Click **Create**. 6. Your `Workspace name` and `Workspace ID` will be created. +{% hint style="info" %} +### Additional References You can also refer [official Bitbucket Workspace page](https://support.atlassian.com/bitbucket-cloud/docs/what-is-a-workspace/) for more details. +{% endhint %} + + -**Note**: -* repo - Full control of repositories (Read, Write, Admin, Delete) access. \ No newline at end of file diff --git a/docs/user-guide/jobs/workflow-editor-job.md b/docs/user-guide/jobs/workflow-editor-job.md index 46743a53507..12eaa736755 100644 --- a/docs/user-guide/jobs/workflow-editor-job.md +++ b/docs/user-guide/jobs/workflow-editor-job.md @@ -45,7 +45,7 @@ The **Source type** - "Pull Request" allows you to configure the CI Pipeline usi > Before you begin, [configure the webhook](../creating-application/workflow/ci-pipeline.md#configuring-webhook) for either GitHub or Bitbucket. -> The "Pull Request" source type feature only works for the host GitHub or Bitbucket cloud for now. To request support for a different Git host, please create a github issue [here](https://github.com/devtron-labs/devtron/issues). +> The "Pull Request" source type feature only works for the host GitHub or Bitbucket cloud for now. To request support for a different Git host, please create a GitHub issue [here](https://github.com/devtron-labs/devtron/issues). To trigger the build from specific PRs, you can filter the PRs based on the following keys: