Skip to main content

Manage

This topic describe how to manage the application using the Helm

Update an Application​

Before updating the iceDQ application, we strongly recommend to to connect with iceDQ support team to check the compatibility and any breaking changes.

Login​

To log in, use the command below, replacing the email with the one given to the iceDQ team:

helm registry login registry.icedq.com --username <email> --password <strong-password>

Run preflight checks​

IMPORTANT

Preflight checks are critical for a successful installation. The following rules apply:

  • ❌ Preflight Check Failures: If preflight checks fails, the installation must not continue until the targeted environment meets all requirements. Please reach out to our support team.
  • ⚠️ Preflight Check Warnings: If preflight checks return warnings, the installation can proceed, but it is recommended that you address these warnings to comply with our recommendations.
  • Install preflight
curl https://krew.sh/preflight | bash

OR

curl -L https://github.com/replicatedhq/troubleshoot/releases/latest/download/preflight_linux_amd64.tar.gz | tar xzvf -
sudo ./preflight version
  • Run the pre-flight check
helm template oci://registry.icedq.com/icedq/stable/icedq | kubectl preflight -

OR

 helm template oci://registry.icedq.com/icedq/stable/icedq --values values.yaml | ./preflight -

Upgrade the application​

helm upgrade <release-name> -n icedq oci://registry.icedq.com/icedq/stable/icedq

for example

helm upgrade icedq -n icedq oci://registry.icedq.com/icedq/stable/icedq

Replace <release-name> with the name used during the initial installation (use helm ls to find it). If needed, specify the namespace with -n (default namespace is used if not specified).

This will upgrade your application to the latest version. To upgrade to a specific version, use the --version flag:

helm upgrade icedq -n icedq oci://registry.icedq.com/icedq/stable/icedq --version 2024.2.3

Verify the installation​

Upon successful installation, you should see the following output:

NOTES:
To access the Application use below URL:
https://app.icedq.net

You can get the first user credentials with below commands:

Username: kubectl get secrets icedq-keycloak -o jsonpath="{.data.APP_USER}" | base64 --decode && echo
Password: kubectl get secrets icedq-keycloak -o jsonpath="{.data.APP_USER_PASSWORD}" | base64 --decode && echo

These notes can later be retrieved with helm get notes <release-name>

If you opt to install an embedded database it will include the commands to get the database credentials as well.

Once all the pods are in running state, you can start using the application.

Updating application configuration​

Modify the application configuration with an updated values file using the helm upgrade command. Stick to the same version using the --version flag:

helm upgrade <release-name> -n <namespace> oci://registry.icedq.com/icedq/stable/icedq --reuse-values --version 2024.2.3 -f updated-local-values.yaml

Replace <release-name> with the name used during the initial installation (use helm ls to find it). If needed, specify the Kubernetes namespace with -n (default namespace is used if not specified).

Uninstall​

IMPORTANT

Please be sure before un-installing the application as it may loose the existing configuration of the application. Persistent Volume data will be still available in case of accidental uninstall.

If you wish to uninstall the application, you can do it with below command.

helm uninstall <release-name>

Get the release name by running helm ls

Last updated on