diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index aff20b6a73..110aeb359c 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -73,6 +73,10 @@ * [Debugging Deployment And Monitoring](user-guide/debugging-deployment-and-monitoring.md) * [Application Metrics](user-guide/creating-application/app-metrics.md) * [Overview](user-guide/creating-application/overview.md) +* [Application Groups](user-guide/application-groups/README.md) + * [Overview](user-guide/application-groups/overview-app-group.md) + * [Build and Deploy](user-guide/application-groups/app-group-build-and-deploy.md) + * [Configurations](user-guide/application-groups/app-group-configuration.md) * [Resource Browser](user-guide/resource-browser.md) * [Charts](user-guide/deploy-chart/README.md) * [Charts Overview](user-guide/deploy-chart/overview-of-charts.md) diff --git a/docs/user-guide/application-groups/README.md b/docs/user-guide/application-groups/README.md new file mode 100644 index 0000000000..167c17561f --- /dev/null +++ b/docs/user-guide/application-groups/README.md @@ -0,0 +1,22 @@ +# Application Groups + +In the `Application Groups` section, you will find all the applications which are created under the same environment. +As an example, applications with the [CD pipelines](https://docs.devtron.ai/v/v0.6/usage/applications/creating-application/cd-pipeline) deployed in the same [environment](https://docs.devtron.ai/v/v0.6/global-configurations/cluster-and-environments#add-environment) (e.g., `devtron-demo`), will be available in the same application group. + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/application-groups.jpg) + +| Fields | Description | +| --- | --- | +| **Environment** | The name of the environment. | +| **Namespace** | The name of the namespace. | +| **Cluster** | The name of the cluster. | +| **Applications** | Number of applications created in the same environment. | + +You can search by using the `environment` name or you can also filter by the `cluster` name as shown in the above image. + +The benefits of using `Application Groups` in Devtron: +- To trigger build pipelines for multiple applications in bulk. +- To trigger deployment pipelines for the same environment across multiple applications in bulk. + + +`Note`: Users with [super admin](https://docs.devtron.ai/v/v0.6/global-configurations/authorization/user-access#role-based-access-levels) permission can view all the applications in the `Application Groups`. Other users can view the applications in the `Application Groups` for which they have `View only` permission or higher. \ No newline at end of file diff --git a/docs/user-guide/application-groups/app-group-build-and-deploy.md b/docs/user-guide/application-groups/app-group-build-and-deploy.md new file mode 100644 index 0000000000..3a4c0fbf80 --- /dev/null +++ b/docs/user-guide/application-groups/app-group-build-and-deploy.md @@ -0,0 +1,28 @@ +# Build and Deploy + +For the applications to be built and deployed on pushing a change, the build and deployment pipelines must be set to `AUTO`. On the `Build and Deploy` section of the `Application Groups`, you can trigger build or deploy more than one application at the same time. You can also `Select all apps` to trigger build or deploy all the applications. + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/build-and-deploy-app-groups.jpg) + + +There are two main steps for building and deploying applications: + +* [Triggering CI](triggering-ci.md) + +* [Triggering CD](triggering-cd.md) + + +## Application with pre-deployment/post deployment pipeline + +The application with the pre-deployment or post-deployment pipeline can also be selected by triggering: + +* [Trigger Pre-deployment stage](https://docs.devtron.ai/v/v0.6/usage/applications/creating-application/cd-pipeline#3.-pre-deployment-stage) +* [Trigger Deployment](https://docs.devtron.ai/v/v0.6/usage/applications/creating-application/cd-pipeline#4.-deployment-stage) +* [Trigger Post-deployment stage](https://docs.devtron.ai/v/v0.6/usage/applications/creating-application/cd-pipeline#5.-post-deployment-stage) + + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/pre-deployment-app-groups.jpg) + + + + diff --git a/docs/user-guide/application-groups/app-group-configuration.md b/docs/user-guide/application-groups/app-group-configuration.md new file mode 100644 index 0000000000..c876836401 --- /dev/null +++ b/docs/user-guide/application-groups/app-group-configuration.md @@ -0,0 +1,13 @@ +# Configurations + +For the `Application Groups`, you can configure the following for the specific application: + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/configurations-app-groups.jpg) + +* [Deployment Template](deployment-template.md) + +* [Config Maps](config-maps.md) + +* [Secrets](secrets.md) + + diff --git a/docs/user-guide/application-groups/applications groups.md b/docs/user-guide/application-groups/applications groups.md new file mode 100644 index 0000000000..66cdb124c1 --- /dev/null +++ b/docs/user-guide/application-groups/applications groups.md @@ -0,0 +1,21 @@ +# Application Groups + +`Application Groups` is a new functionality in Devtron. In the `Application Groups` section, you will find all the applications which are created under the same environment. +As an example, if you create two applications `app-A` and `app-B` and add them in the same [environment](https://docs.devtron.ai/v/v0.6/global-configurations/cluster-and-environments#add-environment) (e.g., `devtron-demo`), you will find both the applications in the same application group (environment name). + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/application-groups.jpg) + +| Fields | Description | +| --- | --- | +| **Environment** | The name of the environment. | +| **Namespace** | The name of the namespace. | +| **Cluster** | The name of the cluster. | +| **Applications** | Number of applications created in the same environment. | + +You can search by using the `environment` name or you can also filter by the `cluster` name as shown in the above image. + +The benefits of using `Application Groups` in Devtron: +- To deploy mulitple microservices. +- To perform bulk CI/CD across multiple applciations under the same environment. + +`Note`: You must have a [super admin](https://docs.devtron.ai/v/v0.6/global-configurations/authorization/user-access#role-based-access-levels) permission to access all the applications in the `Application Groups`. Permission users with `admin` can access only the limited applications which they created. \ No newline at end of file diff --git a/docs/user-guide/application-groups/overview-app-group.md b/docs/user-guide/application-groups/overview-app-group.md new file mode 100644 index 0000000000..4c5c3a60d6 --- /dev/null +++ b/docs/user-guide/application-groups/overview-app-group.md @@ -0,0 +1,34 @@ +# Overview + +The `Overview` section of the `Application Groups` contains the brief information of all the applications, application status, deployment status of the particular environment. + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/overview-app-groups.jpg) + +The following details are provided on the **Overview** page: + +| Fields | Description | +| :--- | :--- | +| **Environment** | Displays the name of the environment. | +| **Namespace** | Displays the namespace. | +| **Cluster** | Displays the cluster name. | +| **Application** | Displays the list of applications created in the particular environment. | +| **App Status** | Displays the application status against the application. E.g., `Healthy`, `Not deployed` etc. | +| **Deployment Status** | Displays the deployment status of the application. | +| **Last Deployed** | Displays the time at which the application was last deployed. | + + + + + + + + + + + + + + + + +