Helm Release
Helm Release is an instance of a chart running in a Kubernetes cluster. Users can create a Helm Release when creating a project or through the Helm Install menu.
Getting Started with Helm Release
To get started with Helm Release, follow these steps:
- Main page, click the Project card. Move to the Project Dashboard page.
- In the left menu, click Build/Deploy > Kubernetes Deploy. Move to the Kubernetes Deploy page.
Item Description Name Displays the deployment name. Click to view detailed information. Chart Displays information about the Helm chart used for deployment. Cluster/Namespace Displays the cluster/namespace where the deployment is located. Pod Status Displays the current status of the Pod. Deployment Result Displays the result of the deployment execution. Deployment Time Displays the deployment execution time. Refresh Refreshes the current item. The items that change are Pod status, deployment result, and deployment time. Delete Deletes the current item. Table. Helm Release Items - On the Kubernetes Deploy page, click the Name in the Helm Release list. Move to the Deployment Details page.
Adding Helm Release
Helm Install
You can add a Helm Release through Helm Install.
Adding Related Helm Release
To add a related Helm Release, follow these steps:
- Main page, click the Project card. Move to the Project Dashboard page.
- In the left menu, click Build/Deploy > Kubernetes Deploy. Move to the Kubernetes Deploy page.
- Click the Add Related Helm Release button. The Add Related Helm Release popup window opens.
- In the Add Related Helm Release popup window, enter each item.
- Click the Save button to complete adding the Helm Release.
| Item | Description |
|---|---|
| Helm Release already registered in the project | Displays the Helm Release already registered in the project.
|
Managing Helm Release Secrets
Getting Started with Helm Release Secrets
Helm Release Secrets allows you to manage the ImagePull Secret used for the image deployed through the build pipeline.
To get started with Helm Release Secrets, follow these steps:
- On the Deployment Details page, click the Edit Authentication Information icon to the right of Helm Release.
- The Helm Release Secrets popup window opens.
Adding Helm Release Secrets
To add a Helm Release Secret, follow these steps:
- On the Deployment Details page, click the Edit Authentication Information icon to the right of Helm Release. The Helm Release Secrets popup window opens.
- In the Helm Release Secrets popup window, if you need to add a secret to pull a private chart image, click the Add button in the Chart Install Secret section. The Add Secret popup window opens.
- If you need to add a secret to pull the app image used for build/deploy, click the Add button in the ImagePull Secret section. The Add Secret popup window opens.
- In the Add Secret popup window, enter the secret-related content and click the Save button to complete the addition.
| Item | Description |
|---|---|
| Registry URL | Select the image to use for ImagePull Secret from the image list in the image repository. |
| Secret | Select the method for entering secret information
|
Modifying Helm Release Secrets
To modify a Helm Release Secret, follow these steps:
- On the Deployment Details page, click the Edit Authentication Information icon to the right of Helm Release. The Helm Release Secrets popup window opens.
- In the Helm Release Secret list, click the name of the secret you want to modify. The Modify Secret popup window opens.
- Modify the content and click the Save button to complete the modification.
Deleting Helm Release Secrets
To delete a Helm Release Secret, follow these steps:
- On the Deployment Details page, click the Edit Authentication Information icon to the right of Helm Release. The Helm Release Secrets popup window opens.
- In the Helm Release Secret list, click the name of the secret you want to delete.
- Click the Delete button to complete the deletion.
Modifying K8S Authentication Information
K8S authentication information refers to the authentication information used to verify the authority to use the K8S cluster/namespace when performing deployment in the build pipeline.
To modify the K8S authentication information, follow the procedure below.
- Deployment Details page, click the Edit Authentication Information icon to the right of K8S Cluster/Namespace. The Edit Authentication Information popup window will open.
- The authentication information is fixed to the account of the logged-in user. Click the Save button to modify it.
- In the confirmation popup window, click the Confirm button.
- The K8S authentication information will be changed to the logged-in user.
Checking values.yaml used in Helm Release
To check the contents of values.yaml, follow these steps:
- On the Deployment Details page, click the History tab.
- In the Values column, click the View icon. The Revision # - Values.yaml popup window opens.
- Check the contents of the
values.yamlfile.
Comparing values.yaml used in Helm Release
To compare the contents of values.yaml used in each release, follow these steps:
- On the Deployment Details page, click the History tab.
- In the list, select the checkboxes of the two revisions you want to compare.
- Click the Yaml Diff button. The Yaml Diff popup window opens.
- In the Yaml Diff (Revision #>#) popup window, check the comparison contents.
Rolling Back Helm Release
To roll back a Helm Release to a previous revision, follow these steps:
- On the Deployment Details page, click the History tab.
- Click the Rollback button for the revision you want to roll back. The Rollback popup window opens.
- Click the Confirm button to complete the rollback.
Upgrading Helm Release
To upgrade a Helm Release, follow these steps:
- On the Deployment Details page, click the History tab.
- In the Values column, click the View icon. The Revision # - Values.yaml popup window opens.
- Modify the contents of the current Values.yaml and click the Upgrade button. The Upgrade popup window opens.
- Check the information being upgraded.
- Click the Execute button to complete the upgrade.
Viewing Pod Logs
To view the logs of Pods related to Helm Release, follow these steps:
- On the Deployment Details page, click the Release Objects tab.
- In the Pod Items section, click the LOG icon in the LOG column. The Log popup window opens.
| Item | Description |
|---|---|
| Container | Select the container for which you want to output logs. |
| Real-time Refresh | Refreshes the log output in real-time. |
| Stop Refresh | Stops real-time refresh. |
| Download | Downloads the Pod log as a file. |
Deleting Helm Release
To delete a Helm Release, follow these steps:
- On the Deployment Details page, click the Delete button at the bottom right of Helm Release. The Delete Helm Release popup window opens.
- Click the Confirm button to complete the deletion.
Also execute the Helm delete command
- Selected: The Helm Release is actually deleted from the cluster.
- Not selected: Only deleted from the Kubernetes Deploy list and remains in the cluster.