Fuzzball Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Logging In and Selecting Your Group

After deciding whether to use the web UI or the CLI to interact with Fuzzball and confirming that you meet all prerequisites, you can log in. Follow the instructions in either the web UI or CLI tab below, depending on your preferred method.

Please select either the web UI or CLI tab to see the appropriate instructions for your environment.

When you first visit the Fuzzball URL (provided by your administrator), you will see a sign-in page looking like this:

Fuzzball cloud instance sign-on page

After signing in you will be re-directed to the Workflow catalog:

Workflow Catalog

Fuzzball will activate your default group. In our examples this will be the shared group named “SA”. You can change the group for the current session using the dropdown menu in the lower left corner.

If available, it’s a good idea to select a shared group managed by your administrator to complete this quick start guide. If you select your “User group”, you may need to set up Resource Definitions before you can provision hardware to run your jobs. This is beyond the scope of the 15 minute tutorial.

After selecting your shared group, you may see workflows submitted by other group members. Sharing workflows is one of the benefits of using a shared group.

The Fuzzball CLI needs to know which context (i.e. Fuzzball installation) you want to interact with. The context is automatically determined by the web UI since you point your browser to a URL. But the CLI needs you to create the appropriate context before you login.

This command contains a series of URLs and an organization ID that you can obtain from your administrator.

$ fuzzball context create beta api.beta.fuzzball.io \
  https://auth.fuzzball.io/auth/realms/db17f530-ef85-429c-bcca-f6faa5ab86ce \
  fuzzball-cli
Configuration for "beta" created.
Configuration for "beta" now in use.

$ fuzzball context list
ACTIVE | NAME | ACCOUNT
   *   | beta |

The first command creates the context (in this case named beta) so that you can access the appropriate Fuzzball cluster. The second command lists your available contexts and highlights (with a *) the currently used context. In this case, the only context available is obviously the one that is used.

If you have created more than one context and want to select the appropriate one, you can use use, the fuzzball context use <context name> command.

Now you can log into the context with the following command:

$ fuzzball context login
Logging into current cluster context...
Using a secure browser, open the link to complete login:
https://auth.fuzzball.io/auth/realms/db17f530-ef85-429c-bcca-f6faa5ab86ce/device?user_code=DPGB-URVO

Waiting for login completion...

The system will open this link in your default browser, guiding you through a secure web-based authentication process.

Alternatively, if you prefer a browser-free approach or are working in an environment without GUI access, you can authenticate directly through the terminal:

$ fuzzball context login --direct

This command will prompt you to enter your username and password. For security purposes, your password will not be visible as you type it in the terminal.

When using the --direct flag with the login command, Fuzzball automatically checks for environment variables $FUZZBALL_USER and $FUZZBALL_PASSWORD. If these variables are set, Fuzzball will use them as credentials without prompting you for input—useful for automated scripts and CI/CD pipelines.

Selecting a group at login

By default, fuzzball context login activates your personal User Account group. If you belong to one or more shared groups, you’ll likely want to switch into one of them — workflows you submit run under the active group, and submitting from your User Account often requires Resource Definitions you may not have set up yet.

You can select the group as part of the login itself with --group/-g. The flag accepts either the group name or its UUID:

$ fuzzball context login --group SA
Logging into current cluster context...
Group "SA" in use

Without --group, login completes into your default group; if you have no default set, your User Account is used. You can list the groups you can access at any time and switch between them after the fact:

$ fuzzball group list
SELECTED | ID                                   | NAME
         | 4ba9824b-0c12-43cf-9e9a-833881004a0d | SA
   *     | 74a78835-1601-4364-a85c-0eee707b8017 | dgodlove@ciq.co

The * indicates the active group. Switching to a shared group is a single command (name or UUID both work):

$ fuzzball group use SA
Group "SA" in use

$ fuzzball group list
SELECTED | ID                                   | NAME
   *     | 4ba9824b-0c12-43cf-9e9a-833881004a0d | SA
         | 74a78835-1601-4364-a85c-0eee707b8017 | dgodlove@ciq.co