Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Credentials Manager

Workspace secrets—such as API tokens, database credentials, or service keys—are securely managed using the EOxHub Credentials Manager. This tool ensures sensitive information is not hard-coded in notebooks, workflows, or shared files.

Credentials manager

Figure 1:Credentials manager

Key Features

Example Use Cases

Credential types

More detailed information about these secret types can be found in the official documentation: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

Creation

TypeExample
Opaque (key-value)

You can add one or more key-value pairs.
dockerconfigjson

The provided credentials are converted to a valid json and stored in the secret.
ssh-auth

You can either upload the key file or paste the key in the text area.

Modification / Deletion

TypeExample
Opaque (key-value)

  • add / remove key-value pairs

  • change individual keys / values

  • opaque_edit.png
    dockerconfigjson

    The credentials can be changed, the current state of the currently stored json is shown in the (readonly) textarea below.
    dockerconfigjson-view.png
    ssh-auth

    The ssh-privatekey is masked and immutable once it’s stored. If you need to change the key, you need to delete the secret first and then recreate it.
    ssh-auth-view.png

    Special modes

    Opaque (key-value) can be set to readonly or key-only (has to be done by an administrator). Readonly & key-only credentials can only be viewed, but not edited or deleted.

    Credential can only be viewed, not edited or deleted.

    Figure 2:Credential can only be viewed, not edited or deleted.

    ModeExample
    readonlyopaque-readonly.png
    key-onlyopaque-keyonly.png

    Inject as environment variables into Jupyterlab

    Opaque (key-value) secrets can injected as environment variables in Jupyterlab by enabling the Inject as env var into jupyterlab button below the credential.

    If you enable/disable this button you need to restart the Jupyterlab session to see its effect.

    Inject as env into JupyterlabExample
    disabledopaque-inject-env-disabled.png
    enabledopaque-inject-env-enabled.png
    How to access env it in Jupyterlab Notebook:access-env-var.png