Available in VPC
Add-on installation and management
You can install add-ons, change their settings and versions, and delete them. For minor version upgrades of add-ons that support Canary upgrades, see Canary upgrade.
Install during cluster creation
When creating a cluster, specify the add-ons to install in the Add-on step. The specified add-ons are installed during cluster creation. For the complete cluster creation procedure, see Getting started with Ncloud Kubernetes Service.
Specify the following items:
- Select add-ons: Select the checkbox for each add-on to install. You can specify multiple add-ons at once.
- Select version: Select the version to install from the add-on's Version dropdown.
- Enter settings: Click [Advanced settings], enter the settings in the Add add-on popup, and click [Save]. If no values are entered, the default values are used.
Install add-ons on a running cluster
Add add-ons that are not installed on a running cluster. Add-ons that are already installed are displayed as "Installed" and cannot be selected.
To install an add-on on a running cluster:
- On the cluster details page, click the [Add-on] tab.
- Click [Import add-on].
- When the Import add-on popup appears, select the checkbox for the add-on to install.
- Select the version to install from the Version dropdown.
- To enter settings, click [Advanced settings], enter them in the Add add-on popup, and click [Save]. If no values are entered, the default values are used.
- Click [Import]. Installation starts.
Change settings and upgrade versions
Change the version and settings of an installed add-on. The Edit add-on popup opens with the current settings already entered.
For add-ons that support Canary upgrades, this procedure can only change the patch version within the same minor version. To upgrade the minor version, use Canary upgrade. While a Canary upgrade is in progress, you cannot edit or delete the add-on.
To edit an installed add-on:
- On the cluster details page, click the [Add-on] tab.
- Select the add-on to edit, then click [Edit]. The Edit add-on popup appears.
- Change the version if necessary. You can click to select a version that is compatible with the cluster.
- Modify the settings if necessary.
- Select a method in Conflict management (conflict resolution). For details, see Conflict management.
- Click [Save]. The changes are applied.
If the changes are rejected or validation fails, the system automatically attempts to restore the previous working state (version and settings). However, automatic restoration does not apply if the changes were applied but the runtime becomes abnormal afterward (e.g., repeated container restarts).
Conflict management
An add-on creates the final configuration by applying the settings entered by the user to the default settings and applies it to the cluster. Default settings are used for items that are not entered. Changing the configuration by entering settings does not constitute a conflict.
Conflicts occur only in fields that the user has modified directly in the cluster (e.g., kubectl edit). If no fields have been modified directly, the result is the same regardless of the method selected.
The following methods are available in Conflict management (conflict resolution) in the Edit add-on popup.
| Method | Description |
|---|---|
| Overwrite | Default method. Overwrites fields with the final configuration values even if the user has modified them directly. Tasks do not fail due to conflicts. |
| Preserve | Fields modified directly by the user are left unchanged, and only the remaining fields are updated with the final configuration values. The task may fail if a directly modified value conflicts with the final configuration value. |
Delete add-on
Remove an installed add-on from the cluster. To delete an installed add-on:
- On the cluster details page, click the [Add-on] tab.
- Select the add-on to delete, then click [Delete].
- Review the details in the Delete add-on popup, enter the name of the add-on to delete, and click [Delete]. Deletion starts.
Deleting an add-on removes the resources installed through the add-on. Before deletion, make sure that no workloads that depend on the add-on resources remain in the cluster. However, resources containing user data (e.g., volume snapshots in use) may be retained for protection. Remove any retained resources manually when necessary.
Canary upgrade
A Canary upgrade installs a new minor version of an add-on alongside the existing version, gradually migrates workloads to verify it, and then confirms the new version. If issues are found, you can remove the new version and revert to the existing version. The upgrade consists of the following 3 stages:
- Start: The new version is installed alongside the existing version. The existing version continues to run.
- Verify: Workloads are gradually migrated to the new version to confirm that they work properly.
- Confirm or cancel: If you confirm, the new version becomes the production version and the existing version is removed. If you cancel, the new version is removed and the existing version is retained.
To check which add-ons support Canary upgrades, see the Add-on list. [Canary upgrade] is enabled only when you select an add-on that supports Canary upgrades, and is disabled if the add-on is not "Active" or no upgradable version is available.
Add-ons that support Canary upgrades have a revision identifier for each installed version line. A revision is derived from the major and minor version numbers (e.g., the revision of version 1.30.3 is 1-30). During the verification stage, both revisions exist in the cluster, and you can check each revision in the task result details table in the console.
Before you begin
Before starting a Canary upgrade, check the following:
- The versions available for upgrade are displayed in the Target version dropdown of the Start Canary popup. The next minor version after the current version is provided.
- When starting, you can specify the settings to apply to the new version. If you do not specify them, the current settings are used as is. If you specify them, they replace the current settings.
- While a Canary upgrade is in progress, you cannot perform the following tasks. Perform them after ending the upgrade by confirming or canceling it.
- Editing or deleting the add-on
- Upgrading the cluster's Kubernetes version
- Starting a new Canary upgrade for the same add-on
Check Canary status
Add-ons undergoing a Canary upgrade have a Canary status separate from their existing status. Click [View task result details] for the add-on to view the running version and the Canary version along with their revisions and statuses. The Canary statuses are as follows.
| Status | Meaning | Available actions |
|---|---|---|
| Installing Canary | Installing the new version | Waiting for completion |
| Canary running | Verification stage in which both versions run together | Confirm, Cancel |
| Canary installation failed | New version installation failed | Retry start, Cancel |
| Completing Canary | Confirmation in progress | Waiting for completion |
| Canary completion failed | Confirmation failed | Retry confirmation |
| Canceling Canary | Cancellation in progress | Waiting for completion |
| Canary cancellation failed | Cancellation failed | Retry cancellation |
Start a Canary upgrade
Install the new version of an add-on alongside the existing version.
- On the cluster details page, click the [Add-on] tab.
- Select the target add-on, then click [Canary upgrade].
- When the Start Canary popup appears, select the version to upgrade to from the Target version dropdown.
- Enter the settings to apply to the new version if necessary.
- Review the information, then click [Start]. Installation of the new version starts.
When the installation is complete, the Canary status changes to "Canary running" and the verification stage begins.
Migrate workloads
During the verification stage, workloads continue to use the existing revision. You must migrate workloads to the new revision directly in the cluster and verify them. We recommend proceeding sequentially, starting with the namespaces that have the smallest impact. The migration method varies by add-on. For details, see the Canary upgrade section for the add-on in the Add-on list.
Confirm and cancel
When verification is complete, end the upgrade by confirming or canceling it. Click [View task result details] for the target add-on to enable the buttons for the actions available in the current Canary status.
- Confirm: Click [Confirm]. In the Complete Canary popup, review the changes, select the checkbox to acknowledge that this action cannot be undone, and click [Confirm]. The new version becomes the production version, and the existing revision is removed. This action cannot be undone once confirmed.
- Cancel: Click [Cancel]. Review the details in the Cancel Canary popup, then click [Run cancellation]. The new revision is removed, and the existing version is retained.
Confirming or canceling does not migrate workloads that use the revision being removed. Before confirming, make sure that all workloads have been migrated to the new revision. Before canceling, make sure that any workloads migrated to the new revision have been reverted to the existing revision.
Check failed Canary tasks
If a task fails, the Canary status is displayed as "Canary installation failed", "Canary completion failed", or "Canary cancellation failed." To check the reason for the failure, click [View task result details] and see the status log message. Even if the start fails, the existing version continues to run. If confirmation or cancellation fails, the removal may be only partially complete, so check the message and retry the same task to finish it.
You can retry the start only for the same version, using [Canary upgrade]. You can modify the settings when retrying. To proceed with a different version, cancel the upgrade and start a new one.
You can also start, confirm, and cancel Canary upgrades using the Cluster Add-on Canary upgrade API.
Check failed tasks
If a task fails, the add-on status is displayed as "Installation failed", "Update failed", or "Deletion failed", and the cause is shown in the status log message when you click [View task result details]. Check the message, adjust the settings, version, or conflict management method, and then try again.