Docker credentials

Use these tutorials to add Docker credentials to a Saagie project, as well as modify or delete them.

The credentials used for this example are not real and will result in an error. Use your own Docker credentials when following this tutorial.

1. Add Docker credentials

Let’s add a set of Docker credentials to the project Dunder Mifflin Paper Sales.

You are in a project where you have the right to work with Docker credentials.

1.1. Navigate to your project

Start by navigating to the example project.

Go to the Projects module from the primary navigation menu.
Go to the Dunder Mifflin Paper Sales project.
Go to Docker credentials from the secondary navigation menu.
Select the New credentials button.

1.2. Add your Docker credentials

A panel will appear to add your credentials.

Select the type of credentials. For this example, we’ll choose Docker Hub.

If you choose private Docker registry, you’ll also need to provide the URL.
Enter your username: stanley
Enter your password.
Select the Save button.

Your Docker credentials are now saved in your project and can be used by jobs and custom apps.

2. Edit Docker credentials

Anytime your Docker credentials change (for example, you changed your username or password on Docker Hub), you need to update them in your project.

2.1. Navigate to Docker credentials

Navigate to your project’s Docker credentials.

Go to the Projects module from the primary navigation menu.
Go to the Dunder Mifflin Paper Sales project.
Go to Docker credentials from the secondary navigation menu.
Open the Docker credentials you need to edit.

2.2. Edit credentials

We need to change the type of credential from Docker Hub to a private Docker registry. Additionally, Stanley changed his username, but kept the same password.

Select the dropdown for credentials type, then choose private Docker registry.
Enter the name of your private Docker registry: dunder/jupyterspark:2.0
Change Stanley’s username to stanleyhudson.
Leave the password field blank because the password did not change.
Select the Save button.

Your edited Docker credentials are ready to be used by jobs and custom apps.

3. Delete Docker credentials

3.1. Navigate to Docker credentials

Navigate to your project’s Docker credentials.

Go to the Projects module from the primary navigation menu.
Go to the Dunder Mifflin Paper Sales project.
Go to Docker credentials from the secondary navigation menu.
Open the Docker credentials you need to delete.

3.2. Delete credentials

The same panel that opened when editing your credentials will open again.

This time, select the Delete credentials button.
A prompt will open to confirm that you’d like to delete these credentials.
Select the Delete button.

This set of Docker credentials has been deleted and can no longer be used.

If your Docker credentials are used by any jobs or custom apps, deleting them might cause problems for those jobs or apps.