Skip to content

Commit d72249d

Browse files
stevsmitSteven Smith
and
Steven Smith
authored
Updates attributes (#599)
Co-authored-by: Steven Smith <stevsmit@stevsmit.remote.csb>
1 parent e071563 commit d72249d

15 files changed

+124
-126
lines changed

modules/backing-up-red-hat-quay-standalone.adoc

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
11
:_content-type: PROCEDURE
22
[[backing-up-red-hat-quay-standalone]]
3-
= Backing up {productname} on standalone deployments
3+
= Backing up {productname} on standalone deployments
44

5-
This procedure describes how to create a backup of {productname} on standalone deployments.
5+
This procedure describes how to create a backup of {productname} on standalone deployments.
66

77
.Prerequisites
88

9-
.Procedure
9+
.Procedure
1010

11-
. Create a temporary backup directory, for example, `quay-backup`:
11+
. Create a temporary backup directory, for example, `quay-backup`:
1212
+
1313
[source,terminal]
1414
----
1515
$ mkdir /tmp/quay-backup
1616
----
1717

18-
. The following example command denotes the local directory that the {productname} was started in, for example, `/opt/quay-install`:
18+
. The following example command denotes the local directory that the {productname} was started in, for example, `/opt/quay-install`:
1919
+
20-
[source,terminal]
20+
[subs="verbatim,attributes"]
2121
----
2222
$ podman run --name quay-app \
2323
-v /opt/quay-install/config:/conf/stack:Z \
2424
-v /opt/quay-install/storage:/datastorage:Z \
2525
{productrepo}/{quayimage}:{productminv}
2626
----
2727
+
28-
Change into the directory that bind-mounts to `/conf/stack` inside of the container, for example, `/opt/quay-install`, by running the following command:
28+
Change into the directory that bind-mounts to `/conf/stack` inside of the container, for example, `/opt/quay-install`, by running the following command:
2929
+
3030
[source,terminal]
3131
----
3232
$ cd /opt/quay-install
3333
----
3434

35-
. Compress the contents of your {productname} deployment into an archive in the `quay-backup` directory by entering the following command:
35+
. Compress the contents of your {productname} deployment into an archive in the `quay-backup` directory by entering the following command:
3636
+
3737
[source,terminal]
3838
----
@@ -51,9 +51,9 @@ ssl.cert
5151
ssl.key
5252
----
5353

54-
. Back up the Quay container service by entering the following command:
54+
. Back up the Quay container service by entering the following command:
5555
+
56-
[source,terminal]
56+
[subs="verbatim,attributes"]
5757
----
5858
$ podman inspect quay-app | jq -r '.[0].Config.CreateCommand | .[]' | paste -s -d ' ' -
5959

@@ -63,11 +63,11 @@ $ podman inspect quay-app | jq -r '.[0].Config.CreateCommand | .[]' | paste -s -
6363
{productrepo}/{quayimage}:{productminv}
6464
----
6565
66-
. Redirect the contents of your `conf/stack/config.yaml` file to your temporary `quay-config.yaml` file by entering the following command:
66+
. Redirect the contents of your `conf/stack/config.yaml` file to your temporary `quay-config.yaml` file by entering the following command:
6767
+
6868
[source,terminal]
6969
----
70-
$ podman exec -it quay cat /conf/stack/config.yaml > /tmp/quay-backup/quay-config.yaml
70+
$ podman exec -it quay cat /conf/stack/config.yaml > /tmp/quay-backup/quay-config.yaml
7171
----
7272
7373
. Obtain the `DB_URI` located in your temporary `quay-config.yaml` by entering the following command:
@@ -90,15 +90,15 @@ $ postgresql://<username>:test123@172.24.10.50/quay
9090
$ pg_dump -h 172.24.10.50 -p 5432 -d quay -U <username> -W -O > /tmp/quay-backup/quay-backup.sql
9191
----
9292
93-
. Print the contents of your `DISTRIBUTED_STORAGE_CONFIG` by entering the following command:
93+
. Print the contents of your `DISTRIBUTED_STORAGE_CONFIG` by entering the following command:
9494
+
9595
[source,yaml]
9696
----
9797
DISTRIBUTED_STORAGE_CONFIG:
9898
default:
9999
- S3Storage
100100
- s3_bucket: <bucket_name>
101-
storage_path: /registry
101+
storage_path: /registry
102102
s3_access_key: <s3_access_key>
103103
s3_secret_key: <s3_secret_key>
104104
host: <host_name>
@@ -108,7 +108,7 @@ DISTRIBUTED_STORAGE_CONFIG:
108108
+
109109
[source,terminal]
110110
----
111-
$ export AWS_ACCESS_KEY_ID=<access_key>
111+
$ export AWS_ACCESS_KEY_ID=<access_key>
112112
----
113113
114114
. Export the `AWS_SECRET_ACCESS_KEY` by using the `secret_key` obtained in Step 7:
@@ -133,5 +133,5 @@ download: s3://<user_name>/registry/sha256/e9/e9c5463f15f0fd62df3898b36ace8d1538
133133
----
134134
[NOTE]
135135
====
136-
It is recommended that you delete the `quay-config.yaml` file after syncing the `quay` bucket because it contains sensitive information. The `quay-config.yaml` file will not be lost because it is backed up in the `quay-backup.tar.gz` file.
136+
It is recommended that you delete the `quay-config.yaml` file after syncing the `quay` bucket because it contains sensitive information. The `quay-config.yaml` file will not be lost because it is backed up in the `quay-backup.tar.gz` file.
137137
====

modules/clair-standalone-quay-config.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
. Stop the `Quay` container if it is running, and restart it in configuration mode, loading the existing configuration as a volume:
55
+
66
[subs="verbatim,attributes"]
7-
....
8-
$ sudo podman run --rm -it --name quay_config \
7+
----
8+
$ sudo podman run --rm -it --name quay_config \
99
-p 80:8080 -p 443:8443 \
1010
-v $QUAY/config:/conf/stack:Z \
1111
{productrepo}/{quayimage}:{productminv} config secret
12-
....
12+
----
1313

1414
. Log in to the configuration tool and enable scanning in the Security Scanner section of the UI. Set the HTTP endpoint for Clair using a port that is not already in use on the `quay-server` system, for example `8081`. Create a Clair pre-shared key (PSK) using the `Generate PSK` button, for example:
1515
+

modules/clair-standalone-running.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ $ sudo podman run -d --rm --name clairv4 \
99
-p 8081:8081 -p 8089:8089 \
1010
-e CLAIR_CONF=/clair/config.yaml -e CLAIR_MODE=combo \
1111
-v /etc/clairv4/config:/clair:Z \
12-
{productrepo}/{clairimage}:{productminv}
12+
{productrepo}/{clairimage}:{productminv}
1313
....
1414

1515

1616
. Next, restart the `Quay` container using the updated configuration file containing the scanner settings:
1717
+
1818
[subs="verbatim,attributes"]
19-
....
19+
----
2020
$ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
2121
--name=quay \
2222
-v $QUAY/config:/conf/stack:Z \
2323
-v $QUAY/storage:/datastorage:Z \
2424
{productrepo}/{quayimage}:{productminv}
25-
....
25+
----

modules/config-api-default.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
= Retrieving the default configuration
1+
= Retrieving the default configuration
22

33
If you are running the configuration tool for the first time, and do not have an existing configuration, you can retrieve the default configuration. Start the container in config mode:
44

55
[subs="verbatim,attributes"]
6-
....
7-
$ sudo podman run --rm -it --name quay_config \
6+
----
7+
$ sudo podman run --rm -it --name quay_config \
88
-p 8080:8080 \
99
{productrepo}/{quayimage}:{productminv} config secret
10-
....
10+
----
1111

1212
Use the `config` endpoint of the configuration API to get the default:
1313

modules/config-api-retrieve.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
If you have already configured and deployed the Quay registry, stop the container and restart it in configuration mode, loading the existing configuration as a volume:
44

55
[subs="verbatim,attributes"]
6-
....
7-
$ sudo podman run --rm -it --name quay_config \
6+
----
7+
$ sudo podman run --rm -it --name quay_config \
88
-p 8080:8080 \
99
-v $QUAY/config:/conf/stack:Z \
1010
{productrepo}/{quayimage}:{productminv} config secret
11-
....
11+
----
1212

1313
Use the `config` endpoint of the API to get the current configuration:
1414

modules/config-file-location.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
[id="config-file-location"]
33
= Location of configuration file in a standalone deployment
44

5-
For standalone deployments of {productname}, the `config.yaml` file must be specified when starting the {productname} registry. This file is located in the configuration volume. For example, the configuration file is located at `$QUAY/config/config.yaml` when deploying {productname} by the following command:
5+
For standalone deployments of {productname}, the `config.yaml` file must be specified when starting the {productname} registry. This file is located in the configuration volume. For example, the configuration file is located at `$QUAY/config/config.yaml` when deploying {productname} by the following command:
66

7-
[source,terminal]
7+
[subs="verbatim,attributes"]
88
----
99
$ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
1010
--name=quay \

modules/config-file-minimal.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[id="config-file-minimal"]
33
= Minimal configuration
44

5-
The following configuration options are required for a standalone deployment of {productname}:
5+
The following configuration options are required for a standalone deployment of {productname}:
66

77
* Server hostname
88
* HTTP or HTTPS
@@ -16,7 +16,7 @@ The following configuration options are required for a standalone deployment of
1616
[id="sample-config-file-minimal"]
1717
== Sample minimal configuration file
1818

19-
The following example shows a sample minimal configuration file that uses local storage for images:
19+
The following example shows a sample minimal configuration file that uses local storage for images:
2020

2121
[source,yaml]
2222
----
@@ -60,11 +60,11 @@ The `SETUP_COMPLETE` field indicates that the configuration has been validated.
6060
[id="config-local-storage"]
6161
== Local storage
6262

63-
Using local storage for images is only recommended when deploying a registry for proof of concept purposes.
63+
Using local storage for images is only recommended when deploying a registry for proof of concept purposes.
6464

65-
When configuring local storage, storage is specified on the command line when starting the registry. The following command maps a local directory, `$QUAY/storage` to the `datastorage` path in the container:
65+
When configuring local storage, storage is specified on the command line when starting the registry. The following command maps a local directory, `$QUAY/storage` to the `datastorage` path in the container:
6666

67-
[source,terminal]
67+
[subs="verbatim,attributes"]
6868
----
6969
$ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
7070
--name=quay \
@@ -76,7 +76,7 @@ $ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
7676
[id="config-cloud-storage"]
7777
== Cloud storage
7878

79-
Storage configuration is detailed in the xref:config-fields-storage[Image storage] section. For some users, it might be useful to compare the difference between Google Cloud Platform and local storage configurations. For example, the following YAML presents a Google Cloud Platform storage configuration:
79+
Storage configuration is detailed in the xref:config-fields-storage[Image storage] section. For some users, it might be useful to compare the difference between Google Cloud Platform and local storage configurations. For example, the following YAML presents a Google Cloud Platform storage configuration:
8080

8181
.$QUAY/config/config.yaml
8282
[source,yaml]
@@ -95,7 +95,7 @@ DISTRIBUTED_STORAGE_PREFERENCE:
9595

9696
When starting the registry using cloud storage, no configuration is required on the command line. For example:
9797

98-
[source,terminal]
98+
[subs="verbatim,attributes"]
9999
----
100100
$ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
101101
--name=quay \

modules/georepl-deploy-standalone.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ For example, for a machine running in Europe with the config
1111
directory on the host available from `$QUAY/config`:
1212
+
1313
[subs="verbatim,attributes"]
14-
....
14+
----
1515
$ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
1616
--name=quay \
1717
-v $QUAY/config:/conf/stack:Z \
1818
-e QUAY_DISTRIBUTED_STORAGE_PREFERENCE=europestorage \
1919
{productrepo}/{quayimage}:{productminv}
20-
....
20+
----
2121
+
2222
[NOTE]
2323
====

modules/mirroring-worker.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
[id="mirroring-worker"]
22
= Mirroring worker
33

4-
Use the following procedure to start the repository mirroring worker.
4+
Use the following procedure to start the repository mirroring worker.
55

6-
.Procedure
6+
.Procedure
77

8-
* If you have not configured TLS communications using a `/root/ca.crt` certificate, enter the following command to start a `Quay` pod with the `repomirror` option:
8+
* If you have not configured TLS communications using a `/root/ca.crt` certificate, enter the following command to start a `Quay` pod with the `repomirror` option:
99
+
10-
[source,terminal]
10+
[subs="verbatim,attributes"]
1111
----
1212
$ sudo podman run -d --name mirroring-worker \
1313
-v $QUAY/config:/conf/stack:Z \
1414
{productrepo}/{quayimage}:{productminv} repomirror
1515
----
1616

17-
* If you have configured TLS communications using a `/root/ca.crt` certificate, enter the following command to start the repository mirroring worker:
17+
* If you have configured TLS communications using a `/root/ca.crt` certificate, enter the following command to start the repository mirroring worker:
1818
+
19-
[source,terminal]
19+
[subs="verbatim,attributes"]
2020
----
2121
$ sudo podman run -d --name mirroring-worker \
2222
-v $QUAY/config:/conf/stack:Z \
2323
-v /root/ca.crt:/etc/pki/ca-trust/source/anchors/ca.crt:Z \
24-
{productrepo}/{quayimage}:{productminv} repomirror
24+
{productrepo}/{quayimage}:{productminv} repomirror
2525
----

modules/proc_deploy_quay_common_superuser.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ A `superuser` is a Quay user account that has extended privileges, including the
1111
1212
== Adding a superuser to Quay using the UI
1313

14-
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.
14+
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.
1515

1616
. Start the `Quay` container in configuration mode, loading the existing configuration as a volume:
1717
+
1818
[subs="verbatim,attributes"]
1919
....
20-
$ sudo podman run --rm -it --name quay_config \
20+
$ sudo podman run --rm -it --name quay_config \
2121
-p 8080:8080 \
2222
-p 443:8443 \
2323
-v $QUAY/config:/conf/stack:Z \
2424
{productrepo}/{quayimage}:{productminv} config secret
2525
....
2626

27-
. 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`.
27+
. 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`.
2828

2929
. 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:
3030
+
@@ -37,13 +37,13 @@ $ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
3737
-v $QUAY/storage:/datastorage:Z \
3838
{productrepo}/{quayimage}:{productminv}
3939
```
40-
40+
4141

4242
== Editing the config.yaml file to add a superuser
4343

4444
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`.
4545

46-
* Stop the container registry if it is running, and add the `SUPER_USERS` array to the `config.yaml` file:
46+
* Stop the container registry if it is running, and add the `SUPER_USERS` array to the `config.yaml` file:
4747
+
4848
[source,yaml]
4949
----
@@ -56,33 +56,33 @@ SUPER_USERS:
5656

5757
== Accessing the superuser admin panel
5858

59-
. Restart the Quay registry:
59+
. Restart the Quay registry:
6060
+
6161
[subs="verbatim,attributes"]
62-
```
62+
----
6363
$ sudo podman rm -f quay
6464
$ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
6565
--name=quay \
6666
-v $QUAY/config:/conf/stack:Z \
6767
-v $QUAY/storage:/datastorage:Z \
6868
{productrepo}/{quayimage}:{productminv}
69-
```
69+
----
7070
. 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.
7171
+
7272
image:super-user-admin-panel.png[Super User Admin Panel]
7373

7474
=== Creating a globally visible user message
7575

76-
Using the Superuser Admin Panel, you can create `Normal`, `Warning`, or `Error` messages for your organization.
76+
Using the Superuser Admin Panel, you can create `Normal`, `Warning`, or `Error` messages for your organization.
7777

78-
. Click your user name in the top right-hand corner of the UI. Select `Super User Admin Panel`.
78+
. Click your user name in the top right-hand corner of the UI. Select `Super User Admin Panel`.
7979

80-
. On the {productname} Management page, click `Globally visible user messages` on the left hand pane.
80+
. On the {productname} Management page, click `Globally visible user messages` on the left hand pane.
8181

82-
. Click `Create Message` to show a drop-down menu containing `Normal`, `Warning`, and `Error` message types:
82+
. Click `Create Message` to show a drop-down menu containing `Normal`, `Warning`, and `Error` message types:
8383
+
8484
image:create-new-message.png[Creating a new messsage]
8585

86-
. Enter a message by selecting `Click to set message`, then click `Create Message`.
86+
. Enter a message by selecting `Click to set message`, then click `Create Message`.
8787

88-
Messages can be deleted by clicking `Options` and then `Delete Message`.
88+
Messages can be deleted by clicking `Options` and then `Delete Message`.

0 commit comments

Comments
 (0)