Skip to content

Commit 92afee8

Browse files
added new config-tool docs (quay#94)
1 parent ee31a55 commit 92afee8

6 files changed

+27
-69
lines changed

images/Figure01.png

13.1 KB
Loading

images/Figure05.png

57.7 KB
Loading

modules/proc_deploy_quay_add.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ run {productname} as a container, as follows:
4848
====
4949
Add `-e DEBUGLOG=true` to the `docker run` command line for
5050
the quay container to enable debug level logging.
51+
Add `-e IGNORE_VALIDATION=true` to bypass validation during
52+
the startup process.
5153
====
5254
+
5355
[subs="verbatim,attributes"]

modules/proc_deploy_quay_guided.adoc

Lines changed: 11 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -8,42 +8,25 @@ Later, you use that password to log into the configuration tool as the user `qua
88

99
Here's an example of how to do that:
1010

11-
. **Start quay in config mode**: On the first quay node, run the following:
11+
. **Start quay in setup mode**: On the first quay node, run the following:
1212
+
1313
[subs="verbatim,attributes"]
1414
....
15-
# docker run --privileged=true -p 8443:8443 -d {productrepo}/quay:{productminv} config my-secret-password
15+
# docker run --rm -it --name quay_config --privileged=true -p 8080:8080 {productrepo}/quay:{productminv} config my-secret-password
1616
....
1717

18-
. **Open browser**: When the quay configuration tool starts up, open a browser to the URL and port 8443
18+
. **Open browser**: When the quay configuration tool starts up, open a browser to the URL and port 8080
1919
of the system you are running the configuration tool on
20-
(for example https://myquay.example.com:8443). You are prompted for a username and password.
20+
(for example http://myquay.example.com:8080). You are prompted for a username and password.
2121

2222
. **Log in as quayconfig**: When prompted, enter the `quayconfig` username and password
2323
(the one from the `docker run` command line).
2424

25-
. **Choose configuration mode**: You are prompted to choose to either create a new
26-
{productname} configuration file or edit an existing one in these two modes:
27-
28-
* **Start New Registry Setup**: The result of this selection is the creation of a new
29-
configuration file (`config.yaml`) and optional `ssl.cert` and `ssl.key` files.
30-
Those files are bundled into a tarball file you can use to
31-
actually deploy all your {productname} nodes.
32-
33-
* **Modify an existing configuration**: With this selection, you are prompted
34-
to provide an existing tarball and
35-
modify it before you use it to start your {productname} nodes.
36-
+
37-
The following figure shows an example of the resulting `Choose an option` page:
38-
+
39-
image:Figure00x.png[Identifying the database {productname} will use]
40-
+
41-
For an initial setup, you are asked to identify the database type.
42-
For a subsequent configuration, you are prompted for a tarball containing the
43-
`config.yaml` and credential files (optional). Then you
44-
can continue on with the configuration.
45-
46-
. **Identify the database**: For the initial setup, add the following information about the type and location of the database to be used by {productname}:
25+
. **Fill in the required fields**: When you start the config tool without mounting an existing configuration bundle,
26+
you will be booted into an initial setup session. In a setup session, default values will be filled automatically. The following
27+
steps will walk through how to fill out the remaining required fields.
28+
29+
. **Identify the database**: For the initial setup, you must include the following information about the type and location of the database to be used by {productname}:
4730
+
4831
* **Database Type**: Choose MySQL or PostgreSQL. MySQL will be used in the basic example; PostgreSQL is used with the
4932
high availability {productname} on OpenShift examples.
@@ -63,18 +46,6 @@ The following figure shows an example of the screen for identifying the database
6346
+
6447
image:Figure01.png[Identifying the database {productname} will use]
6548

66-
+
67-
. **Validate database**: Select `Validate Database Settings`, and proceed to the next screen.
68-
69-
. **Create {productname} superuser**: You need to set up an account with superuser privileges to {productname}, to use for editing {productname} configuration settings. That information includes a Username, Email address, and Password (entered twice).
70-
+
71-
The following figure shows an example of the {productname} Setup screen for setting up a {productname} superuser account:
72-
+
73-
image:Figure03.png[Set up a Quay superuser account to do Quay configuration]
74-
75-
+
76-
Select `Create Super User`, and proceed to the next screen.
77-
7849
. **Identify the Redis hostname, Server Configuration and add other desired settings**: Other setting you can add to complete the setup are as follows. More settings for high availability {productname} deployment that for the basic deployment:
7950

8051
+
@@ -133,9 +104,9 @@ you must explicitly whitelist the namespaces for which it is enabled.
133104
* **Dockerfile Build Support**: Enable to allow users to submit Dockerfiles to be built and pushed to {productname}.
134105
This is not recommended for multitenant environments.
135106
136-
. **Save the changes**: Select `Save Configuration Changes`. You are presented with the following Download Configuration screen:
107+
. **Validate the changes**: Select `Validate Configuration Changes`. If validation is successful, you will be presented with the following Download Configuration modal:
137108
+
138-
image:Figure04.png[Download the {productname} configuration tarball to the local system]
109+
image:Figure05.png[Download the {productname} configuration tarball to the local system]
139110
. **Download configuration**: Select the `Download Configuration` button and save the
140111
tarball (`quay-config.tar.gz`) to a local directory to use later to start {productname}.
141112

modules/proc_deploy_quay_openshift.adoc

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -203,15 +203,10 @@ https://quay-enterprise-config-quay-enterprise.apps.test.example.com
203203
- Password: **secret**
204204

205205
+
206-
You are prompted to select a configuration mode, as shown in the following figure:
207-
+
208-
image:Figure00.png[Identifying the database {productname} will use]
209-
210-
211-
. **Choose configuration mode**: Select "Start new configuration for this cluster"
212-
The result of this selection is the creation of a new
213-
configuration file (`config.yaml`) that you will use later for your {productname} deployment.
214-
206+
. **Fill in the required fields**: When you start the config tool without mounting an existing configuration bundle,
207+
you will be booted into an initial setup session. In a setup session, default values will be filled automatically. The following
208+
steps will walk through how to fill out the remaining required fields.
209+
215210
. **Identify the database**: For the initial setup, add the following information about the type and location of the database to be used by {productname}:
216211
- **Database Type**: Choose MySQL or PostgreSQL. PostgreSQL is used with the
217212
example shown here.
@@ -230,22 +225,10 @@ NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
230225
postgres NodePort 172.30.127.41 <none> 5432:32212/TCP 19h
231226
```
232227
+
233-
The following figure shows an example of the screen for identifying the database used by {productname}.
234-
The example yaml file sets the database server to `postgres`,
235-
the user name to `username`, the password to `password`, and the database to `quay`:
228+
The following figure shows an example of the screen for identifying the database used by {productname}:
236229
+
237230
image:Figure01.png[Identifying the database {productname} will use]
238231

239-
+
240-
. **Validate database**: Select `Validate Database Settings` and proceed to the next screen.
241-
242-
. **Create {productname} superuser**: You need to set up an account with superuser privileges to {productname}, to use for editing {productname} configuration settings. That information includes a Username, Email address, and Password (entered twice).
243-
+
244-
The following figure shows an example of the {productname} Setup screen for setting up a {productname} superuser account:
245-
+
246-
image:Figure03.png[Set up a {productname} superuser account to do {productname} configuration]
247-
+
248-
Select `Create Super User`, and proceed to the next screen.
249232

250233
. **Identify settings**: Go through each of the following settings. The minimum you must enter includes:
251234
+
@@ -316,9 +299,9 @@ you must explicitly whitelist the namespaces for which it is enabled.
316299
- **Dockerfile Build Support**: Enable to allow users to submit Dockerfiles to be built and pushed to {productname}.
317300
This is not recommended for multitenant environments.
318301

319-
. **Save the changes**: Select `Save Configuration Changes`. You are presented with the following Download Configuration screen:
302+
. **Validate the changes**: Select `Validate Configuration Changes`. If validation is successful, you will be presented with the following Download Configuration modal:
320303
+
321-
image:Figure04.png[Download the {productname} configuration tarball to the local system]
304+
image:Figure05.png[Download the {productname} configuration tarball to the local system]
322305
. **Download configuration**: Select the `Download Configuration` button and save the
323306
tarball (`quay-config.tar.gz`) to a local directory. Save this file in case you want to deploy
324307
the config files inside manually or just want a record of what you deployed.

modules/proc_manage-advanced-config.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,17 +74,19 @@ after the initial {productname} deployment, you can restart the
7474
Config Tool to modify your {productname} cluster. Here's how:
7575

7676
. **Start quay in config mode**: On the first `quay` node run the following, replacing
77-
`my-secret-password` with your password:
77+
`my-secret-password` with your password. If you would like to modify an existing config bundle,
78+
you can simply mount your configuration directory into the Quay container as you would in registry mode.
7879
+
7980
[subs="verbatim,attributes"]
8081
....
81-
# podman run --rm -it --name quay_config -p 8443:8443 -v \
82-
-d {productrepo}/quay:{productminv} config my-secret-password
82+
# docker run --rm -it --name quay_config --privileged=true -p 8080:8080 \
83+
-v path/to/config-bundle:/conf/stack \
84+
{productrepo}/quay:{productminv} config my-secret-password
8385
....
8486

85-
. **Open browser**: When the quay configuration tool starts up, open a browser to the URL and port 8443
87+
. **Open browser**: When the quay configuration tool starts up, open a browser to the URL and port 8080
8688
of the system you are running the configuration tool on
87-
(for example https://myquay.example.com:8443). You are prompted for a username and password.
89+
(for example https://myquay.example.com:8080). You are prompted for a username and password.
8890

8991
At this point, you can begin modifying your {productname} cluster as described earlier.
9092

0 commit comments

Comments
 (0)