Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Gitbook assets moved to AWS S3 #4380

Merged
merged 2 commits into from
Dec 11, 2023
Merged

docs: Gitbook assets moved to AWS S3 #4380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3534d6d
Gitbook Assets Moved to AWS S3
ashokdevtron Dec 11, 2023
f721de0
Reverted changes made in script folder
ashokdevtron Dec 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 docs/.gitbook/assets/preview (1) (1).gif → docs/.gitbook/assets/preview.gif
View file
Open in desktop
File renamed without changes
2 changes: 1 addition & 1 deletion docs/user-guide/app-details/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# App Details

![](../../.gitbook/assets/terminal-open.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/terminal-open.jpg)

[Terminal](terminal.md)
2 changes: 1 addition & 1 deletion docs/user-guide/app-details/terminal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
A pod can have one or more containers running, and a container can have no or multiple shells running in it.
If you are not able to create a successful connection, try changing the shell, as the container may not have that shell running.

![](../../.gitbook/assets/terminal-controls.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/terminal-controls.jpg)

### Connection Status

Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/app-labels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ values.

Labels are optionals and can be entered `key:values` format. multiple labels can be added without repeating `key` name.

![](../.gitbook/assets/app-labels-1.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-labels/app-labels-1.jpg)

### 2. Application meta info

Expand All @@ -25,13 +25,13 @@ left button next to application name `?`.

This will open show you the applications meta details like project, labels associated with it.

![](../.gitbook/assets/app-labels-2.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-labels/app-labels-2.jpg)

### 3. Edit Labels to existing apps

We also add or remove labels for app from here.

![](../.gitbook/assets/app-labels-2.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-labels/app-labels-2.jpg)

### 3. Label Payload

Expand Down
31 changes: 10 additions & 21 deletions docs/user-guide/bulk-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,17 @@ Bulk edit is currently supported for:

## Steps:

1. Click on the `Bulk Edit` option in the main navigation. This is where you can write and execute scripts to perform bulk updates in Devtron objects.
1. Click on the `Bulk Edit` option in the main navigation. This is where you can write and execute scripts to perform bulk updates in Devtron objects.

![](../.gitbook/assets/bulk-update-empty.png)
<br>

2. To help you get started, a script template is provided under the `See Samples` section.
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/bulk-edit/bulk-update-empty.jpg)

![](../.gitbook/assets/bulk-update-readme.png)
<br>
2. To help you get started, a script template is provided under the `See Samples` section.

3. Copy and Paste the `Sample Script` in the code editor and make desired changes. Refer `Payload Configuration` in the Readme to understand the parameters.
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/bulk-edit/bulk-update-readme.jpg)

3. Copy and Paste the `Sample Script` in the code editor and make desired changes. Refer `Payload Configuration` in the Readme to understand the parameters.

![](../.gitbook/assets/bulk-update-script.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/bulk-edit/bulk-update-script.jpg)

### Example
Example below will select all applications having `abc and xyz` present in their name and out of those will exclude applications having `abcd and xyza` in their name. Since global flag is false and envId 23 is provided, it will make changes in envId 23 and not in global deployment template for this application.
Expand Down Expand Up @@ -90,23 +87,15 @@ The following tables list the configurable parameters of the Payload component i
| `secret.spec.names` | Names of all Secrets to be updated. | `secret1`,`secret2`|
| `configMap.spec.patchJson` / `secret.spec.patchJson` | String having the update operation for ConfigMaps/Secrets(you can apply more than one changes at a time). It supports [JSON patch ](http://jsonpatch.com/) specifications for update. | `'[{ "op": "add", "path": "/{key}", "value": "{value}" },{"op": "replace","path":"/{key}","value": "{value}"}]'`(Replace the `{key}` part to the key you want to perform operation on & the `{value}`is the key's corresponding value |



<br>

4. Once you have modified the script, you can click on the `Show Impacted Objects` button to see the names of all applications that will be modified when the script is `Run`.

4. Once you have modified the script, you can click on the `Show Impacted Objects` button to see the names of all applications that will be modified when the script is `Run`.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/bulk-edit/bulk-update-impactobj.jpg)

![](../.gitbook/assets/bulk-update-impactobj.png)
5. Click on the `Run` button to execute the script. Status/Output of the script execution will be shown in the `Output` section of the bottom drawer.

<br>

5. Click on the `Run` button to execute the script. Status/Output of the script execution will be shown in the `Output` section of the bottom drawer.


![](../.gitbook/assets/bulk-update-run.png)
<br>
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/bulk-edit/bulk-update-run.jpg)



8 changes: 4 additions & 4 deletions docs/user-guide/creating-application/config-maps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,23 +106,23 @@ If you are using `Kubernetes External ConfigMap`, make sure you give the name of

You have to ensure that the External ConfigMap exists and is available to the pod.

![](../../.gitbook/assets/config4%20%283%29.jpg)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/config-maps/config4.jpg)

The config map is created.

![](../../.gitbook/assets/created-configmap.gif)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/config-maps/created-configmap.gif)

## Update ConfigMap

You can update your configmap anytime later but you cannot change the name of your configmap. If you want to change the name of the configmap then you have to create a new configmap. To update configmap, click on the configmap you have created make changes as required.

![](../../.gitbook/assets/update_configmap%20%281%29.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/config-maps/update_configmap.jpg)

Click on `Update Configmap` to update your configmap.

## Delete ConfigMap

You can delete your configmap. Click on your configmap and click on the `delete sign` to delete your configmap.

![](../../.gitbook/assets/delete_configmap%20%282%29.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/config-maps/delete_configmap.jpg)

2 changes: 1 addition & 1 deletion docs/user-guide/creating-application/deployment-template/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1097,7 +1097,7 @@ It gives the realtime metrics of the deployed applications
## 2. Show application metrics

If you want to see application metrics like different HTTP status codes metrics, application throughput, latency, response time. Enable the Application metrics from below the deployment template Save button. After enabling it, you should be able to see all metrics on App detail page. By default it remains disabled.
![](../../../.gitbook/assets/deployment_application_metrics%20%282%29.png)
![](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.

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/creating-application/deployment-template/statefulset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -968,7 +968,7 @@ It gives the realtime metrics of the deployed applications
## 2. Show application metrics

If you want to see application metrics like different HTTP status codes metrics, application throughput, latency, response time. Enable the Application metrics from below the deployment template Save button. After enabling it, you should be able to see all metrics on App detail page. By default it remains disabled.
![](../../../.gitbook/assets/deployment_application_metrics%20%282%29.png)
![](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.

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/creating-application/docker-build-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The following fields are provided on the **Store Container Image** section:

**If you are using docker hub account, you need to enter the repository name along with your username. For example - If my username is *kartik579* and repo name is *devtron-trial*, then enter kartik579/devtron-trial instead of only devtron-trial.**

![](../../.gitbook/assets/docker-configuration-docker-hub.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/docker-build-configuration/docker-configuration-docker-hub.jpg)


## Build the Container Image
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/creating-application/environment-overrides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,5 @@ Click on `Update ConfigMap` to update Configmaps.

Click on `Update Secrets` to update Secrets.

![](../../.gitbook/assets/arora4%20%282%29.gif)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/arora4.gif)

2 changes: 1 addition & 1 deletion docs/user-guide/creating-application/workflow/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Workflow is a logical sequence of different stages used for continuous integration and continuous deployment of an application.

![](../../../.gitbook/assets/arora1%20%282%29.gif)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/arora1.gif)

Click on `New Build Pipeline` to create a new workflow

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/creating-application/workflow/automated-test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Users can run the test case using the Devtron dashboard or by including the test

The test cases given in the script will run before the test cases given in the devtron.ci.yaml

![](../../../.gitbook/assets/yaml%20%283%29.jpg)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/yaml.jpg)

| Field | Description |
| :--- | :--- |
Expand Down
28 changes: 14 additions & 14 deletions docs/user-guide/creating-application/workflow/ci-pipeline-legacy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can select the method you want to execute the pipeline. By default the value
### 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.

![](../../../.gitbook/assets/ci-pipeline-2.png)
![](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.
Expand All @@ -42,7 +42,7 @@ Branch Name is the name of the corresponding branch (eg. main or master, or any

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.

![](../../../.gitbook/assets/ci-pipeline-3.png)
![](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 -**
Expand All @@ -54,7 +54,7 @@ To use this mechanism, as stated above you need to create a webhook for the corr
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

![](../../../.gitbook/assets/ci-pipeline-4.png)
![](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 -

Expand All @@ -63,7 +63,7 @@ Now, scroll down and select the custom events for which you want to trigger the

[Note] If you select **Branch or Tag Creation**, it will work for the **Tag Creation** mechanism as well.

![](../../../.gitbook/assets/ci-pipeline-5.png)
![](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.

Expand All @@ -73,19 +73,19 @@ If you are using Bitbucket cloud as your git provider, you need to create a webh
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.

![](../../../.gitbook/assets/ci-pipeline-6.png)
![](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.

![](../../../.gitbook/assets/ci-pipeline-7.png)
![](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.

![](../../../.gitbook/assets/ci-pipeline-8.png)
![](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**.

Expand All @@ -111,7 +111,7 @@ In this process as well you can find the option to filter the specific tags with

Select the appropriate filter and pass the value in the form of regex and then click on **Create Pipeline**.

![](../../../.gitbook/assets/ci-pipeline-9.png)
![](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.
Expand All @@ -129,7 +129,7 @@ This section is used for those steps which you want to execute before building t

You can add one or more than one stage in a CI Pipeline.

![](../../../.gitbook/assets/pre_build.jpg)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/pre_build.jpg)

**\(b\) Docker build**

Expand All @@ -141,7 +141,7 @@ The post-build stage is similar to the pre-build stage. The difference between t

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.

![](../../../.gitbook/assets/post_build%20%282%29.jpg)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/post_build.jpg)

**NOTE:**

Expand All @@ -164,7 +164,7 @@ You can also update any configuration of an already created CI Pipeline, except

Click on your CI pipeline, to update your CI Pipeline. A window will be popped up with all the details of the current pipeline.

![](../../../.gitbook/assets/ca-workflow-update.png)
![]()

Make your changes and click on `Update Pipeline` at the bottom to update your Pipeline.

Expand All @@ -182,7 +182,7 @@ Users can run the test case using the Devtron dashboard or by including the test

The test cases given in the script will run before the test cases given in the devtron.ci.yaml

![](../../../.gitbook/assets/yaml%20%283%29.jpg)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/yaml.jpg)

| Field | Description |
| :--- | :--- |
Expand All @@ -199,7 +199,7 @@ The test cases given in the script will run before the test cases given in the d

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.

![](../../../.gitbook/assets/ca-workflow-linked.png)
![](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 :

Expand Down Expand Up @@ -228,7 +228,7 @@ You cannot trigger build from linked CI pipeline, it can be triggered only from

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.

![](../../../.gitbook/assets/ca-workflow-external.png)
![](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.

Expand Down
Loading
Loading