1166 - 'Quay Enterprise' to 'Red Hat Quay'

This commit is contained in:
Tom McKay 2019-02-25 18:27:11 -05:00
parent b5a5ce7c43
commit 674e471973
24 changed files with 71 additions and 71 deletions

View file

@ -1,10 +1,10 @@
# On-premises installation
Quay Enterprise requires three components to be running to begin the setup process:
Red Hat Quay requires three components to be running to begin the setup process:
- A supported database (MySQL, Postgres)
- A Redis instance (for real-time events)
- The Quay Enterprise image
- The Red Hat Quay image
**NOTE**: Please have the host and port of the database and the Redis instance ready.
@ -27,7 +27,7 @@ sudo docker run -d -p 6379:6379 quay.io/quay/redis
**NOTE**: This host will have to accept incoming connections on port 6379 from the hosts on which the registry will run.
## Downloading the Quay Enterprise image
## Downloading the Red Hat Quay image
After signing up you will be able to download a pull secret file named `config.json`.
@ -63,7 +63,7 @@ Visit the image locally by going to https://yourhost/
**Note**: You will see warning about an invalid certificate authority when visiting in your browser. This is because we self sign the certificate at container load time, so you can safely bypass this warning. (On Chrome, for example, click on Advanced, then "Proceed to localhost")
<img src="img/initial-choice-screen.png" class="img-center" alt="Quay Enterprise Configuration Tool"/>
<img src="img/initial-choice-screen.png" class="img-center" alt="Red Hat Quay Configuration Tool"/>
Click on "Start New Registry Setup", and follow the instructions to create your configuration, downloading and saving it when complete.
@ -72,7 +72,7 @@ Click on "Start New Registry Setup", and follow the instructions to create your
## Setting up the directories
Quay Enterprise requires a configuration directory (and a storage directory if using local storage):
Red Hat Quay requires a configuration directory (and a storage directory if using local storage):
You will need to extract the tarball you received in the previous step into a directory:
```
@ -107,21 +107,21 @@ sudo docker run --restart=always -p 443:443 -p 80:80 --privileged=true -v /local
## Verifying the status of QE
Visit the `/health/endtoend` endpoint on the Quay Enterprise hostname and verify that the `code` is `200` and `is_testing` is `false`.
Visit the `/health/endtoend` endpoint on the Red Hat Quay hostname and verify that the `code` is `200` and `is_testing` is `false`.
If `code` is anything other than `200`, visit http://yourhost/ and you will see instructions detailing the problems Quay Enterprise is having with the configuration.
If `code` is anything other than `200`, visit http://yourhost/ and you will see instructions detailing the problems Red Hat Quay is having with the configuration.
## Logging in
### If using database authentication:
Once Quay Enterprise is running, new users can be created by clicking the `Sign Up` button. If e-mail is enabled, the sign up process will require an e-mail confirmation step, after which repositories, organizations and teams can be setup by the user.
Once Red Hat Quay is running, new users can be created by clicking the `Sign Up` button. If e-mail is enabled, the sign up process will require an e-mail confirmation step, after which repositories, organizations and teams can be setup by the user.
### If using LDAP authentication:
Users should be able to login to the Quay Enterprise directly with their LDAP username and password.
Users should be able to login to the Red Hat Quay directly with their LDAP username and password.
## Updating your configuration
@ -136,12 +136,12 @@ Click on "Modify an existing configuration", and upload the tarball provided whe
You will be taken to the setup page, with your previous configuration values pre-populated. After you have made your changes, save the configuration and download the tarball.
<img src="img/load-tarball-config.png" class="img-center" alt="Quay Enterprise Load Configuration"/>
<img src="img/load-tarball-config.png" class="img-center" alt="Red Hat Quay Load Configuration"/>
Extract the tarball into the config directory where your Quay Enterprise will run:
Extract the tarball into the config directory where your Red Hat Quay will run:
```
mkdir config && tar xzf quay-config.tar.gz -C config
```
Now run Quay Enterprise as stated in the **Running the registry** step, and your new instance will reflect the changes made in the new configuration.
Now run Red Hat Quay as stated in the **Running the registry** step, and your new instance will reflect the changes made in the new configuration.