Deployment Groups

Overview

The most important feature of ZCP v2 is Multi Cluster support. In ZCP v1, ZCP was installed for each cluster, and applications could be deployed, logs collected, and monitoring metrics collected only for that cluster. ZCP v2 is configured to manage multiple Data Plane clusters, deploy applications, and collect data centered on the Control Plane cluster.

ZCP v2's Application (hereinafter referred to as ZCP Application. To distinguish it from the term Application in general) and Deployment Group are concepts for CI/CD for multiple clusters, not a single cluster. CI/CD is ultimately an automation that allows you to continuously perform the process of building an application and deploying the built application to the environment you want. When performing CI/CD for a single cluster, there is no big problem if the process from build to deployment is performed only once. However, if the target is multi-clusters (there are multiple target environments to deploy to), the build should be performed only once, and the deployment should be configured to be executed multiple times by changing the target. In ZCP v2, the concept of ZCP Application for building applications and Deployment Group for deploying to the desired cluster were created to separate the build and deployment processes.

Deployment Group is a concept that groups the target environment where the application will be deployed. The deployment environment targets a Kubernetes cluster and supports various Kubernetes services such as AKS, EKS, IKS, and Native Kubernetes, and is not dependent on a specific CSP (Azure, AWS, IBM, etc.). You can specify one or more Kubernetes clusters and one Namespace in a Deployment Group. When you perform a deployment through a Deployment Group, the same application will be deployed to the Namespace of all clusters specified in the Deployment Group.

You can deploy one or more ZCP Applications in a Deployment Group, and you can set the deployment type (Kubernetes deployment) for each ZCP Application. When performing a deployment, the deployment type specified through the UI is created as Kubernetes Deployment yaml and automatically saved to the Git server. The saved yaml files are applied to the target cluster via ArgoCD.

This is the Deployment Groups list view screen.

A list of registered Deployment Groups is displayed.

• (1) Paging function: You can specify the number of lists in units of 10, 20, 30, 50, and 100 through the paging function on the right and view them on the screen.
• (2) Deployment Group list: This is the list of Deployment Groups. The Deployment Group name, description, Namespace, number of Clusters, and number of Applications are displayed.
• (3) Deployment Group name: Clicking the Name item moves to the details screen.
• (4) Function button: Performs various actions for each Deployment Group. Click the button to move to the details screen or perform the delete function.

Create a Deployment Group

Create a new Deployment Group.

On the Deployment Group screen, click the Create Deployment Group button in the upper left corner.

This is the Deployment Group creation screen.

Below is a description of the input items on the screen.

• Name : Required input value for Deployment Group name. It is a unique value within the same realm and project.

• Display Name : The display name of the Deployment Group.

• Description : Here is a detailed description of the Deployment Group.

• Namespace : The namespace name of Kubernetes where the Deployment Group will be deployed. Namespace must be unique across all projects.

Once you have entered the correct values for each item, the Save button will become active. Clicking the Save button will create the Deployment Group and automatically take you to the edit screen for the created Deployment Group.

Edit Deployment Group

Edit a Deployment Group. The editing screen consists of the Overview, Basic Info, Clusters, Resources, Applications, and Ingress tabs.

Using the Dashboard

Add/Edit Cluster

Manage the list of clusters to which you want to deploy the Deployment Group.

Click the Clusters tab at the top of the screen.

A description of the items in the list.

• Cluster Name: Cluster name.
• Provider: Cloud platform provider.
• Type: Cluster type.
• Status: Cluster operation status, displayed as Ready/Stop/Unknown.
• Health: Cluster health status, displayed as green/yellow/red.
• CPU Request: CPU Request usage percentage value of Deployment Group in Cluster.
• CPU Limit: CPU Limit usage percentage value of Deployment Group in Cluster.
• Mem Request: Mem Request usage percentage value of Deployment Group in Cluster.
• Mem Limit: Mem Limit usage percentage value of Deployment Group in Cluster.
• Actions: Function button group, in order from the left, performs the following functions.

• Configuration: Cluster Configuration 설정

• Delete: Cluster 삭제

Add Cluster

To add a cluster, click the Add Cluster button at the top left of the screen. The Add Cluster pop-up screen opens and displays a list of clusters that can be added.

Select the checkbox of the cluster to be added and click the Add Cluster button. The Add Cluster pop-up screen will close and the cluster added to the list will be searched. When the cluster is added, the namespace set when creating the Deployment Group will be automatically created in the cluster.

Cluster Configuration Settings

Click the Configuration button in the Actions section of the cluster.

The Cluster Configuration pop-up screen will open. The Configuration screen consists of the Resource Quota, Limit Range, and Labels tabs. If there is a previously saved configuration, the pop-up screen will open with the search completed.

Set the Cluster's Resource Quota.

1. Click the Resource Quota tab.
2. Enter values for the items you want to set and click the Save button at the bottom of the screen to complete the save.
3. You can delete the Resource Quota you set by clicking the Delete button at the bottom of the screen.

Set the Limit Range of the Cluster.

1. Click the Limit Range tab.
2. Enter values for the items you want to set and click the Save button at the bottom of the screen to complete saving.
3. You can delete the Limit Range you set by clicking the Delete button at the bottom of the screen.

Sets the label of the cluster.

1. Click the Labels tab.
2. Enter values in the Labels field and click the Save button at the bottom of the screen to complete the save.
3. You can delete the labels you have set by clicking the Delete button at the bottom of the screen.

Delete a Cluster

Click the Delete button in the Actions section of the cluster you want to remove from the Deployment Group. This will not actually delete the cluster, but will remove it from the Deployment Group. Please note that the Namespace created when it was added to the Deployment Group will be deleted, and all resources deployed within it will be deleted.

Add/Edit Resource

Manage the kubernetes resources (Persistent Volume Claims, ConfigMaps, Secrets) that will be deployed to the cluster.

Click the Resources tab at the top of the screen. The Resources screen is structured as follows:

• (1) Deploy button and cluster-specific resource menu: The cluster name registered in the Clusters tab is displayed in the form of a menu. Each cluster name has Persistent Volume Claims, ConfigMaps, and Secrets as submenus.
• (2) Resource Edit: Create or edit a resource in the cluster.
• (3) Resource List: View the list of resources registered in the cluster.

Persistent Volume Claim Setting

Select a cluster from the left menu of the Resources screen, and select the Persistent Volume Claims menu from the cluster's submenu.

A screen where you can create a Persistent Volume Claim (hereinafter referred to as PVC) and a list of PVCs registered in the cluster are displayed.

This is the PVC creation screen.
 

If you enter the correct values for each item, the Save button will be activated. When you click the Save button, the PVC will be created and automatically added to the list at the bottom of the screen.

A description of the items in the list.

• Name: PVC name.
• Bound: PVC Status value in kubernetes.
• Volume: PVC VolumeName value in kubernetes.
• Capacity: Storage Size.
• Access Mode: Access Mode.
• Storage Class: Storage Class name.
• Age: PVC Age value in kubernetes.
• Status: Displayed as one of CREATED/DEPLOYED/UPDATED/UNKNOWN.

Actions: There is a Delete button that performs the deletion function in the function button group.

Clicking the Delete button in the Actions section of the PVC list will delete the corresponding PVC from the cluster. Added or deleted PVCs are not immediately reflected in the cluster, but are reflected through the Deploy function.

ConfigMap Settings

Select a cluster from the left menu of the Resources screen, and select the ConfigMaps menu from the cluster's submenu.

A screen where you can create a ConfigMap and a list of ConfigMaps registered in the cluster are displayed.

This is the ConfigMap creation screen.

If you enter the correct values for each item, the Save button will be activated. When you click the Save button, the ConfigMap will be created and automatically added to the list at the bottom of the screen.

This is a description of the items in the list.

• Name: ConfigMap name.
• Data: The number of data in ConfigMap.
• Age: The Age value of ConfigMap in kubernetes.
• Status: It is displayed as one of the values CREATED/DEPLOYED/UPDATED/UNKNOWN.
• Actions: There is a Delete button that performs the deletion function as a set of function buttons.

Clicking the Name item in the ConfigMap list will display the contents of the corresponding ConfigMap in the input screen, and you can save the edited contents by clicking the Save button.

Clicking the Delete button in the Actions item in the ConfigMap list will delete the corresponding ConfigMap from the cluster. Added or deleted ConfigMaps are not immediately reflected in the cluster, but are reflected through the Deploy function.

Secret Setting

Select a cluster from the left menu of the Resources screen, and select the Secrets menu from the cluster's submenu.

A screen where you can create a Secret and a list of Secrets registered in the cluster are displayed.

This is the Secret creation screen.

Once you have entered the correct values for each item, the Save button will become active. When you click the Save button, the Secret will be created and automatically added to the list at the bottom of the screen.

A description of the items in the list.

• Name: Secret name.
• Type: Secret type.
• Data: Number of data in Secret.
• Age: Secret age value in kubernetes.
• Status: Displayed as one of CREATED/DEPLOYED/UPDATED/UNKNOWN.
• Actions: There is a Delete button that performs the deletion function as a set of function buttons.

If you click the Name item in the Secret list, the contents of the corresponding Secret will be displayed in the input screen, and you can save the edited contents by clicking the Save button.

If you click the Delete button in the Actions item in the Secret list, you can delete the corresponding Secret from the cluster. Added or deleted Secrets are not immediately reflected in the cluster, but are reflected through the Deploy function.

Resource Deploy

Reflects the created/edited/deleted Persistant Volume Claims, ConfigMaps, and Secrets resources in the cluster.

Select a cluster from the left menu of the Resources screen, and then click the Deploy button at the top.

Add/Edit Application

Manage the list of Applications to include in the Deployment Group.

Click the Applications tab at the top of the screen.

Descriptions of the items in the list.

• Name: Application name.
• Description: Application description.
• Ref Pipelines: List of pipelines for Applications included in the Deployment Group.
• Source Repo.: Address of the Application's source repository.
• Image Registry: Address of the Application's build image.
• Last Build Status: Last build status of the Application.
• Actions: A collection of function buttons that perform the following functions in order from the left.

• 
• Detail: Edit Application
• History: View Application Deploy History
• Configuration: Application Configuration settings
• Deploy: Application Deploy
• Delete: Delete Application

Add Application

To add an application, click the Add Application button at the top left of the screen.

The Add Application pop-up screen will appear.

• Select the Application to add from the Choose Application item at the top of the screen.
• Select the checkbox of the pipeline to add from the pipeline list of the searched Application, and set whether to Auto Deploy. When Auto Deploy is enabled, deployment is performed automatically whenever the build of the corresponding pipeline is successful.
• Select the Yaml Generation Policy at the top of the screen. If the Yaml Generation Policy is Always, the Deployment and Service yaml are completely regenerated every time a deployment is performed, and all values stored in the Git server are overwritten. If set to Image Only, only the image path of the first container in the Deployment yaml is changed and saved.
• Specify the number of deployment histories to keep in the History Count at the top of the screen.

Once the pipeline selection for the Application is complete, click the Add Applications button at the bottom of the screen. The Add Application pop-up screen will close and the Application you added to the list will be displayed.

Edit Application

Edit the pipeline of the registered Application.

Click the Detail button in the Actions section of the Application. The Edit Application pop-up screen will open and the details of the Application will be displayed.

• For detailed information on the screen, please refer to the Add Application screen.

Application Configuration Settings

Set the Application Configuration.

Click the Configuration button in the Actions section of the Application to view the Configuration settings in a pop-up screen. Since the Configuration is set for each cluster, the screen consists of Deployment Spec and Advanced (Health Check, Environments, Volumes, Tolerations, Affinities) settings for each cluster. If there is a previously saved Configuration, the pop-up screen opens with the search completed.

Set the Deployment Spec for the application.

1. Select cluster from the tab at the top of the screen.
2. Enter values in the Deployment Spec screen and click the Save button at the bottom of the screen to complete the save.

Set the Advanced items of the Application. Here is an example of the Environments items.

1. Select Environments or Env References in the Advanced tab. In the Environments tab, you can specify values from ConfigMap and Secret as environment variables. 
2. In the Env References tab, you can set ConfigMap and Secret as envFrom.
   Enter the values and click the Save button at the bottom of the screen to complete the save.

Application Deploy

Deploy the application to the cluster.

Click the Deploy button in the Actions section of the Application. The build history of the Application will be displayed in a pop-up screen.

• Select the Build No of the pipeline to be deployed and click the Deploy button at the bottom of the screen.

You can check the deployment results on the Application Deploy History screen.

If the configuration of the application to be deployed is not set, the following error message is displayed.

Application Deploy History Search

Search the deployment history of the application.

Click the History button in the Actions section of the application. The Deploy History list opens on the right side of the screen.

You can check the Deploy History list as many as the number specified in the Application Deployment History Count.

Click the Deploy Log button in the list on the History screen to search the deployment results by cluster.

Application Deletion

Delete the application included in the Deployment Group.

Click the Delete button in the Actions section of the application. At this time, the Deployment and Service actually deployed to the cluster will also be deleted.

Ingress Settings

Manage the Ingresses that will be deployed to your cluster.

Click the Ingress tab at the top of the screen. The Ingress screen is structured as follows:

• (1) Deploy button and cluster list: The cluster names registered in the Clusters tab are displayed in a list format.
• (2) Ingress Edit: Create or edit an Ingress in the cluster.
• (3) Ingress List: View the list of Ingresses registered in the cluster.

Ingress Settings

Select cluster from the left menu on the Ingress screen.

You will see a screen where you can create an Ingress and a list of Ingresses registered in the cluster.

This is the Ingress creation screen.

If you enter the correct values for each item, the Save button will be activated. When you click the Save button, the Ingress will be created and automatically added to the list at the bottom of the screen.

Here is a description of the items in the list.

• Name: Secret name.
• Domain: Secret's domain.
• Tls Secret: Secret's Tls Secret.
• Age: Ingress's Age value in kubernetes.
• Status: Displayed as one of CREATED/DEPLOYED/UPDATED/UNKNOWN.
• Actions: There is a Delete button that performs the deletion function as a set of function buttons.

When you click on the Name item in the Ingress list, the contents of that Ingress will be displayed in the input screen, and any edited contents can be saved by clicking the Save button.

You can delete an Ingress from the cluster by clicking the Delete button in the Actions section of the Ingress list. Added or deleted Ingresses are not immediately reflected in the cluster, but are reflected through the Deploy function.

Ingress Deploy

Reflects created/edited/deleted Ingresses to the cluster.

Select cluster from the left menu of the Resources screen and click the Deploy button at the top.