Helm Release
HelmRelease is an instance of a chart running on a Kubernetes cluster. Users can create a HelmRelease when creating a project or via the HelmInstall menu.
Getting Started with Helm Release
To start HelmRelease, follow these steps.
- From the Main page, click the Project card. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
Item Explanation Name Displays the deployment name. Click to view detailed information. Chart Displays the Helm chart information used for deployment. Cluster/Namespace Displays the deployed cluster/namespace. Pod status Displays the current status of the Pod. Deployment result Displays the deployment execution result. Deployment time Displays the deployment execution time. Refresh Refresh the current items. The items that will be updated are the Pod status, deployment result, and deployment time. Delete Delete the current item. Table. Helm release items - Kubernetes deployment page, click name in the Helm release list. You will be taken to the deployment details page.
Add Helm Release
Helm install
You can add a Helm release through Helm install.
Add related Helm release
To add the related Helm release, follow these steps.
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deployment menu in the left menu. You will be taken to the Kubernetes Deployment page.
- Click the Add related Helm release button. The Add related Helm release popup opens.
- Add related Helm release Enter each item in the popup window.
- Click the Save button to complete adding the Helm release.
Item Explanation Helm release already registered in the project Shows the Helm release already registered in the project. - A Helm release already registered in the project cannot be added.
Table. Items displayed when adding related Helm release
Managing Helm Release Secrets
Getting Started with Helm Release Secrets
In HelmRelease secrets, you can manage the ImagePull Secret used for images deployed through the build pipeline in HelmRelease.
To start HelmRelease secret management, follow the steps below.
- On the Deployment Details page, click the Edit Credentials icon to the right of Helm Release.
- Helm Release Secret The popup window opens.
Adding a secret to a Helm release
To add a Helm release secret, follow these steps.
- On the Deployment Details page, click the Edit Authentication Info icon to the right of the Helm Release. The Helm Release Secret popup will open.
- Helm Release Secret popup window, if you need to add a secret to pull a private Chart Image, click the Add button in the Chart Install Secret area. The Add Secret popup will open.
- If you need to add a secret required to pull the App Image used during build/deployment, click the Add button in the ImagePull Secret area. The Add Secret popup will open.
- Add Secret In the popup window, enter the secret information and click the Save button to complete the addition.
Item Explanation Registry URL From the list of images registered in Image Repository, select the image that ImagePull Secret will use. Secret Select secret input method - Auto-generate: Automatically create a secret using the credentials of the selected image repository from the Docker URL.
- Use existing secret: Select and use one of the already created secrets.
Table. Additional Helm Release Secret Configuration Items
Edit Helm Release Secret
To modify the Helm release secret, follow these steps.
- On the Deployment Details page, click the Edit Authentication Info icon to the right of the Helm Release. The Helm Release Secret popup will open.
- In the HelmRelease secret list, click the secret name you want to edit. Secret Edit popup opens.
- Edit the content and click the Save button to complete the edit.
Delete Helm release secret
To delete a Helm release secret, follow these steps.
- On the Deployment Details page, click the Edit Authentication Info icon to the right of the Helm Release. The Helm Release Secret popup will open.
- Click the secret name you want to delete from the Helm release secret list.
- Click the Delete button to complete the deletion.
Modify K8S credentials
K8S credentials are the authentication information used to verify permission to use a K8S cluster/namespace when performing a deployment in the build pipeline.
To modify the K8S credentials, follow these steps.
- On the Deployment Details page, click the Edit Credentials icon to the right of K8S Cluster/Namespace. The Edit Credentials popup will open.
- Authentication information is fixed to the logged-in user’s account. Click the Save button to edit.
- In the confirmation popup, click the Confirm button.
- K8S authentication information will be changed to the logged-in user.
Check the values.yaml used in the Helm release
To view the contents of values.yaml, follow these steps.
- On the Deployment Details page, click the History tab.
- Click the View icon in the Values column. Revision # - Values.yaml The popup window opens.
- Check the contents of the
values.yamlfile.
Comparing values.yaml used in Helm release
To compare the values.yaml contents used in each release, follow the steps below.
- Click the History tab on the Deployment Details page.
- In the list, click the check box of each of the two revisions you want to compare.
- Click the Yaml Diff button. The Yaml Diff popup window opens.
- Yaml Diff (Revision #>#) Check the comparison details in the popup window.
Rollback 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 of the revision you want to roll back. The Rollback popup window will open.
- Click the Confirm button to complete the rollback.
Upgrade Helm Release
To upgrade HelmRelease, follow the following procedure.
- 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 Current Values.yaml, and click the Upgrade button. The Upgrade popup window will open.
- Check the upgrade information.
- Click the Run button to complete the upgrade.
View Pod logs
To view the logs of the Pod related to a Helm release, follow these steps.
- On the Deployment Details page, click the Release Object tab.
- Click the view icon in the LOG column of the Pod entry. The Log popup window opens.
Item Explanation container Select the container from which you want to output logs. Real-time refresh Refresh the log output in real time. Refresh stopped Stop real-time refresh. Download Download the Pod logs to a file. Table. Log popup window function description
Delete Helm Release
To delete HelmRelease, follow the steps below.
- On the Deployment Details page, click the Delete button at the lower right of the Helm Release. The Delete Helm Release popup opens.
- Click the Confirm button to complete the deletion.
Also execute the helm delete command.
- Select: The Helm release is actually deleted from the cluster.
- Unselected: Kubernetes deployment is removed only from the list and remains in the cluster.