Change the ARTESCA Deployment Name

The deployment name is a label auto-generated at installation that identifies your ARTESCA instance in the UI.

You can change the deployment name to distinguish deployments when multiple ARTESCA instances share the same environment.

The deployment name is displayed in the top navigation bar and in the browser tab title.

Name Constraints

The deployment name must satisfy the following constraints:

  • Length: between 6 and 50 characters.

  • Characters: lowercase letters, digits, and the separators ., -, _.

  • Cannot start or end with a separator.

Procedure

  1. Log in to the ARTESCA UI as a Platform Administrator.

    The current deployment name is displayed as a pill on the left side of the top navigation bar, next to the ARTESCA logo.

  2. Click the deployment name pill.

    The pill turns into an editable text field that contains the current deployment name.

  3. Type the new deployment name and press Enter.

    If the name does not satisfy the Name Constraints, an inline error is displayed below the field and the change is not submitted.

    Tip

    To cancel the edit and keep the current name, press Escape or click outside the text field.

  4. In the Rename deployment? dialog box, review the current and new names, then click Rename to confirm.

    Tip

    To cancel the rename, click Cancel or close the dialog box.

The loader is displayed in the Rename button until the propagation succeeds. Once complete, the new name appears in the navigation bar and browser tab.

  1. Connect to the bootstrap node and patch the cluster-scoped InstanceName custom resource named main.

    [artesca-os@bootstrap ~]$

    sudo kubectl --kubeconfig=/etc/kubernetes/admin.conf patch \
    instancename main --type merge \
    -p '{"spec":{"name":"<new-deployment-name>"}}'

    Replace <new-deployment-name> with a value that satisfies the constraints described above.

  2. Check that the synchronization with Keycloak completed successfully.

    [artesca-os@bootstrap ~]$

    sudo kubectl --kubeconfig=/etc/kubernetes/admin.conf get \
    instancename main -o jsonpath='{.status.conditions}'

    The output must include a condition of type OTPSync with status: "True" and reason: Synced.

Note

The change may take a few minutes to propagate across all services.