proc_deploy_quay_common_superuser.adoc

{productname} superuser

A superuser is a Quay user account that has extended privileges, including the ability to:

• Manage users

• Manage organizations

• Manage service keys

• View the change log

• Query the usage logs

• Create globally visible user messages

Adding a superuser to Quay using the UI

This section covers how to add a superuser using the Quay UI. To add a superuser using the command line interface, see the following section.

1. Start the Quay container in configuration mode, loading the existing configuration as a volume:

   $ sudo podman run --rm -it --name quay_config \
     -p 8080:8080 \
     -p 443:8443 \
     -v $QUAY/config:/conf/stack:Z \
     {productrepo}/{quayimage}:{productminv} config secret

2. Under the Access Settings section of the UI, enter the name of the user (in this instance, quayadmin) in the Super Users field and click Add.

3. Validate and download the configuration file and then terminate the Quay container that is running in config mode. Extract the config.yaml file to the configuration directory and restart the Quay container in registry mode:

   $ sudo podman rm -f quay
   $ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
   --name=quay \
   -v $QUAY/config:/conf/stack:Z \
   -v $QUAY/storage:/datastorage:Z \
   {productrepo}/{quayimage}:{productminv}

Editing the config.yaml file to add a superuser

You can also add a superuser by editing the config.yaml file directly. The list of superuser accounts is stored as an array in the field SUPER_USERS.

• Stop the container registry if it is running, and add the SUPER_USERS array to the config.yaml file:

  SERVER_HOSTNAME: quay-server.example.com
  SETUP_COMPLETE: true
  SUPER_USERS:
    - quayadmin
  ...

Accessing the superuser admin panel

1. Restart the Quay registry:

   $ sudo podman rm -f quay
   $ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
   --name=quay \
   -v $QUAY/config:/conf/stack:Z \
   -v $QUAY/storage:/datastorage:Z \
   {productrepo}/{quayimage}:{productminv}

2. Access the Super User Admin Panel by clicking on the current user’s name or avatar in the top right-hand corner of the UI. If the user has been added as a superuser, an extra item is presented in the drop-down list called Super User Admin Panel.

   

Creating a globally visible user message

Using the Superuser Admin Panel, you can create Normal, Warning, or Error messages for your organization.

1. Click your user name in the top right-hand corner of the UI. Select Super User Admin Panel.

2. On the {productname} Management page, click Globally visible user messages on the left hand pane.

3. Click Create Message to show a drop-down menu containing Normal, Warning, and Error message types:

   

4. Enter a message by selecting Click to set message, then click Create Message.

Messages can be deleted by clicking Options and then Delete Message.