Skip to content

Commit

Permalink
docs: documentation update (devtron-labs#2148)
Browse files Browse the repository at this point in the history
* documentation updated

* correction in documentation update

* correction in git-account.md

* Update cluster-and-environments.md

Co-authored-by: Prakarsh <[email protected]>
  • Loading branch information
Shubham9t9 and prakarsh-dt authored Aug 9, 2022
1 parent 9f82c2a commit 8b8824f
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/user-guide/creating-application/git-material.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Git Repository is used to pull your application source code during the CI step. Select `Git Repository` section of the `App Configuration`. Inside `Git Repository` when you click on `Add Git Repository` you will see three options as shown below:

1. Git Provider
1. Git Account
2. Git Repo URL
3. Checkout Path

Devtron also supports multiple git repositories in a single deployment. We will discuss this in detail in the multi git option [below](git-material.md#4-multi-git).

![](../../.gitbook/assets/create-app-git-account.gif)

## 1. Git Provider
## 1. Git Account

In this section, you have to select the git provider of your code repository like- Github, Gitlab, and Bitbucket, etc. If you are using a private git repository, you can configure your git provider via [git accounts](../global-configurations/git-accounts.md).
In this section, you have to select the git account of your code repository. If the authentication type of the Git account is anonymous, only public git repository will be accessible. If you are using a private git repository, you can configure your git provider via [git accounts](../global-configurations/git-accounts.md).

## 2. Git Repo URL

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,16 @@ Provide the endpoint/URL of your kubernetes cluster.It is recommended to use a s

* **Bearer token**

Provide your kubernetes cluster’s Bearer token for authentication purposes so that the Devtron tool will be able to talk to your kubernetes cluster and can deploy your application in your kubernetes cluster.Generate the admin token to add the cluster on devtron by running the following command. Please ensure that you have kubectl and jq installed on the bastion that you’re running the command.
Provide your kubernetes cluster’s Bearer token for authentication purposes so that Devtron is able to communicate with your kubernetes cluster and can deploy your application in your kubernetes cluster.

Get the server url and generate the bearer token by running the following command:

```bash
curl -O https://raw.githubusercontent.com/devtron-labs/utilities/main/kubeconfig-exporter/kubernetes_export_sa.sh && bash kubernetes_export_sa.sh cd-user devtroncd https://raw.githubusercontent.com/devtron-labs/utilities/main/kubeconfig-exporter/clusterrole.yaml
```

Please ensure that kubectl and jq are installed on the bastion on which you’re running the command.

### 3. Prometheus Info

Prometheus is a powerful solution to provide graphical insight into your application behavior. If you want to see your application matrix against your applications deployed in kubernetes, install Prometheus in your kubernetes cluster. The below inputs are required to configure your prometheus into Devtron’s tool.
Expand Down
4 changes: 3 additions & 1 deletion docs/user-guide/global-configurations/docker-registries.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Container Registries

The global configuration helps you add your `Container Registry`. In the container registry, you provide credentials of your registry, where your images will be stored. And this will be shown to you as a drop-down on `Docker Build Config` Page.
Container registries are used to store images built by the CI Pipeline. Here you can configure the container registry you want to use for storing images.

When configuring an application, you can choose which registry and repository it should use in the App Configuration > [Docker Build Config](../creating-application/deployment-template.md) section.

## Add Container Registry configuration:

Expand Down
21 changes: 14 additions & 7 deletions docs/user-guide/global-configurations/git-accounts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Git Accounts

Git Accounts allow you to connect your code source with Devtron. You’ll be able to use these git accounts to build code using the CI pipeline.
Git Accounts allow you to connect your code source with Devtron. You will be able to use these git accounts to build the code using the CI pipeline.

## Git Account Configuration

Expand Down Expand Up @@ -28,36 +28,43 @@ Provide the `URL`. **For example**- [https://github.com](https://github.com) for

### 4. Authentication type

Here you have to provide the type of authentication required by your version controller. We support three types of authentications. You can choose the one that suits you the best.
Here provide the type of authentication required by your version controller. Devtron supports three types of authentications. You can choose the one that suits you the best.

* **Anonymous**

If you select `Anonymous` then you do not have to provide any username, password/authentication token or SSH key. Just click on `Save` to save your git account provider details.
If authentication type is set as `Anonymous` then you do not need to provide any username, password/authentication token or SSH key. Just click on `Save` to save the git account provider details.
>If authentication type is set as `Anonymous`, only public git repository will be accessible.
![](../../user-guide/global-configurations/images/git-accounts-anonymous.jpg)

* **User Auth**

If you select `User Auth` then you have to provide the `Username` and either of `Password` or `Auth Token` for the authentication of your version controller account. Click on `Save` to save your git account provider details.
If you select `User Auth` then you have to provide the `Username` and either of `Password` or `Auth Token` for the authentication of your version controller account. Click on `Save` to save the git account provider details.

![](../../user-guide/global-configurations/images/git-accounts-user-auth.jpg)

* **SSH Key**

If you choose `SSH Key` then you have to provide the `Private SSH Key` corresponding to the public key added in your version controller account. Click on `Save` to save your git account provider details.
If you choose `SSH Key` then you have to provide the `Private SSH Key` corresponding to the public key added in your version controller account. Click on `Save` to save the git account provider details.

![](../../user-guide/global-configurations/images/git-accounts-ssh.jpg)

## Update Git Account

You can update your saved git account settings at any point in time. Just click on the git account which you want to update. Make the required changes and click on `Update` to save you changes.
You can update your saved git account settings at anytime. To update the git account:

1. Click on the git account which you want to update.
2. Make the required changes
3. Click on `Update` to save the changes.

Updates can only be made within one Authentication type or one protocol type, i.e. HTTPS(Anonymous or User Auth) & SSH. You can update from Anonymous to User Auth & vice versa, but not from Anonymous/User Auth to SSH or reverse.

![](../../user-guide/global-configurations/images/git-account-update.jpg)

### Note:

You can enable and disable your git account settings. If you enable it, then you will be able to see that enabled git account in the drop-down of Git provider.
You can enable or disable a git account. Enabled git accounts will be available to be used in Application configuration > [Git repository](../creating-application/git-material.md).

Disabled git accounts will be unavailable for use in future applications. Applications already using a disabled git account will not be affected.

![](../../user-guide/global-configurations/images/git-account-enable-disable.jpg)

0 comments on commit 8b8824f

Please sign in to comment.