vbatts/quay
Archived
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

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

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

2
config_app/README.md
View file

@ -1,6 +1,6 @@
# Quay config tool
The Quay config tool is a project to ease the setup, modification, and deployment of Red Hat Quay (sometimes referred to as Quay Enterprise).
The Quay config tool is a project to ease the setup, modification, and deployment of Red Hat Quay (sometimes referred to as Red Hat Quay).
The project was built by [Sam Chow] in the summer of 2018.

2
config_app/config_endpoints/api/kube_endpoints.py
View file

@ -13,7 +13,7 @@ logger = logging.getLogger(__name__)
@resource('/v1/kubernetes/deployments/')
class SuperUserKubernetesDeployment(ApiResource):
""" Resource for the getting the status of Quay Enterprise deployments and cycling them """
""" Resource for the getting the status of Red Hat Quay deployments and cycling them """
schemas = {
'ValidateDeploymentNames': {
'type': 'object',

4
config_app/config_util/k8saccessor.py
View file

@ -141,7 +141,7 @@ class KubernetesAccessorSingleton(object):
"""
Removes the old config and replaces it with the new_secret_data as one action
"""
# Check first that the namespace for Quay Enterprise exists. If it does not, report that
# Check first that the namespace for Red Hat Quay exists. If it does not, report that
# as an error, as it seems to be a common issue.
namespace_url = 'namespaces/%s' % (self.kube_config.qe_namespace)
response = self._execute_k8s_api('GET', namespace_url)
@ -251,7 +251,7 @@ class KubernetesAccessorSingleton(object):
if '/' in relative_file_path:
raise Exception('Expected path from get_volume_path, but found slashes')
# Check first that the namespace for Quay Enterprise exists. If it does not, report that
# Check first that the namespace for Red Hat Quay exists. If it does not, report that
# as an error, as it seems to be a common issue.
namespace_url = 'namespaces/%s' % (self.kube_config.qe_namespace)
response = self._execute_k8s_api('GET', namespace_url)

24
config_app/docs/initial_setup.md
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.

22
config_app/docs/kube_setup.md
View file

@ -1,18 +1,18 @@
# Quay Enterprise Installation on Kubernetes
# Red Hat Quay Installation on Kubernetes
This guide walks through the deployment of [Quay Enterprise][quay-enterprise-tour] onto a Kubernetes cluster.
After completing the steps in this guide, a deployer will have a functioning instance of Quay Enterprise orchestrated as a Kubernetes service on a cluster, and will be able to access the Quay Enterprise Setup tool with a browser to complete configuration of image repositories, builders, and users.
This guide walks through the deployment of [Red Hat Quay][quay-enterprise-tour] onto a Kubernetes cluster.
After completing the steps in this guide, a deployer will have a functioning instance of Red Hat Quay orchestrated as a Kubernetes service on a cluster, and will be able to access the Red Hat Quay Setup tool with a browser to complete configuration of image repositories, builders, and users.
[quay-enterprise-tour]: https://quay.io/tour/enterprise
## Prerequisites
A PostgreSQL database must be available for Quay Enterprise metadata storage.
A PostgreSQL database must be available for Red Hat Quay metadata storage.
We currently recommend running this database server outside of the cluster.
## Download Kubernetes Configuration Files
Visit the [RedHat Documentation][RedHat-documentation] and download the pre-formatted pull secret, under "Account Assets". There are several formats of the secret, be sure to download the "dockercfg" format resulting in a `config.json` file. This pull secret is used to download the Quay Enterprise containers.
Visit the [RedHat Documentation][RedHat-documentation] and download the pre-formatted pull secret, under "Account Assets". There are several formats of the secret, be sure to download the "dockercfg" format resulting in a `config.json` file. This pull secret is used to download the Red Hat Quay containers.
This will be used later in the guide.
@ -29,7 +29,7 @@ Next, download each of the following files to your workstation, placing them alo
## Role Based Access Control
Quay Enterprise has native Kubernetes integrations. These integrations require Service Account to have access to Kubernetes API. When Kubernetes RBAC is enabled, Role Based Access Control policy manifests also have to be deployed.
Red Hat Quay has native Kubernetes integrations. These integrations require Service Account to have access to Kubernetes API. When Kubernetes RBAC is enabled, Role Based Access Control policy manifests also have to be deployed.
Kubernetes API has minor changes between versions 1.4 and 1.5, Download appropiate versions of Role Based Access Control (RBAC) Policies.
@ -61,7 +61,7 @@ kubectl create -f quay-servicetoken-role-k8s1-6.yaml
kubectl create -f quay-servicetoken-role-binding-k8s1-6.yaml
```
### Deploy Quay Enterprise objects
### Deploy Red Hat Quay objects
Finally, the remaining Kubernetes objects can be deployed onto Kubernetes:
@ -71,7 +71,7 @@ kubectl create -f quay-enterprise-config-secret.yml -f quay-enterprise-redis.yml
## Expose via Kubernetes Service
In order to access Quay Enterprise, a user must route to it through a Kubernetes Service.
In order to access Red Hat Quay, a user must route to it through a Kubernetes Service.
It is up to the deployer to decide which Service type is appropriate for their use case: a [LoadBalancer](http://kubernetes.io/docs/user-guide/services/#type-loadbalancer) or a [NodePort](http://kubernetes.io/docs/user-guide/services/#type-nodeport).
A LoadBalancer is recommended if the Kubernetes cluster is integrated with a cloud provider, otherwise a NodePort will suffice.
@ -102,9 +102,9 @@ kubectl create -f quay-enterprise-service-nodeport.yml
By default, the quay-enterprise service will be available on port 30080 on every node in the Kubernetes cluster.
If this port conflicts with an existing Kubernetes Service, simply modify the sample configuration file and change the value of NodePort.
## Continue with Quay Enterprise Setup
## Continue with Red Hat Quay Setup
All that remains is to configure Quay Enterprise itself through the configuration tool.
All that remains is to configure Red Hat Quay itself through the configuration tool.
Download the following files to your workstation:
@ -136,7 +136,7 @@ kubectl apply -f qe-config-tool.yml -f config-tool-service-nodeport.yml
By default, the config-tool service will be available on port 30090 on every node in the Kubernetes cluster.
Similar to the Quay application service, if this port conflicts with an existing Kubernetes Service, simply modify the sample configuration file and change the value of NodePort.
Once at the Quay Enterprise setup UI, follow the setup instructions to finalize your installation.
Once at the Red Hat Quay setup UI, follow the setup instructions to finalize your installation.
## Using the Configuration Tool
Click on "Start New Configuration for this Cluster", and follow the instructions to create your configuration, downloading and saving it (to load as a backup or if you ever wish to change your settings).

2
config_app/js/components/download-tarball-modal/download-tarball-modal.component.html
View file

@ -18,7 +18,7 @@
<!-- Body -->
<div class="modal-body download-tarball-modal">
<div ng-if="$ctrl.loadedConfig">
Please download your updated configuration. To deploy these changes to your Quay Enterprise instances, please
Please download your updated configuration. To deploy these changes to your Red Hat Quay instances, please
<a target="_blank" href="https://coreos.com/quay-enterprise/docs/latest/initial-setup.html">
see the docs.
</a>

2
config_app/js/components/kube-deploy-modal/kube-deploy-modal.component.ts
View file

@ -50,7 +50,7 @@ export class KubeDeployModalComponent implements OnDestroy {
this.state = 'error';
this.errorMessage = `There are no Quay deployments active in this namespace. \
Please check that you are running this \
tool in the same namespace as the Quay Enterprise application\
tool in the same namespace as the Red Hat Quay application\
Associated error message: ${err.toString()}`;
})
}

6
config_app/js/core-config-setup/config-setup-tool.html
View file

@ -70,7 +70,7 @@
<td>TLS:</td>
<td>
<select class="form-control" ng-model="mapped.TLS_SETTING">
<option value="internal-tls">Quay Enterprise handles TLS</option>
<option value="internal-tls">Red Hat Quay handles TLS</option>
<option value="external-tls">My own load balancer handles TLS (Not Recommended)</option>
<option value="none">None (Not For Production)</option>
</select>
@ -80,7 +80,7 @@
</div>
<div class="co-alert co-alert-warning" ng-if="mapped.TLS_SETTING == 'external-tls'" style="margin-bottom: 20px">
Terminating TLS outside of Quay Enterprise can result in unusual behavior if the external load balancer is not
Terminating TLS outside of Red Hat Quay can result in unusual behavior if the external load balancer is not
configured properly. <strong>This option is not recommended for simple setups</strong>. Please contact support
if you encounter problems while using this option.
</div>
@ -495,7 +495,7 @@
pattern="http(s)?://.+"></span>
<div class="help-text">
The HTTP URL at which the torrents should be announced. A JWT-compatible tracker such as <a href="https://github.com/chihaya/chihaya" ng-safenewtab>Chihaya</a> must be run to ensure proper security. Documentation on running Chihaya with
this support can be found at <a href="https://tectonic.com/quay-enterprise/docs/latest/running-chihaya.html">Running Chihaya for Quay Enterprise</a>.
this support can be found at <a href="https://tectonic.com/quay-enterprise/docs/latest/running-chihaya.html">Running Chihaya for Red Hat Quay</a>.
</div>
</td>
</tr>

2
config_app/js/setup/setup.component.js
View file

@ -3,7 +3,7 @@ const templateUrl = require('./setup.html');
(function() {
/**
* The Setup page provides a nice GUI walkthrough experience for setting up Quay Enterprise.
* The Setup page provides a nice GUI walkthrough experience for setting up Red Hat Quay.
*/
angular.module('quay-config').directive('setup', () => {

2
config_app/js/setup/setup.html
View file

@ -4,7 +4,7 @@
<div class="page-content" ng-show="currentStep == States.CONFIG">
<div class="cor-title">
<span class="cor-title-link"></span>
<span class="cor-title-content">Quay Enterprise Setup</span>
<span class="cor-title-content">Red Hat Quay Setup</span>
</div>
<div class="co-main-content-panel" style="padding: 20px;">