From 674e4719736214603ac7e53b2d642754d1d5708e Mon Sep 17 00:00:00 2001 From: Tom McKay Date: Mon, 25 Feb 2019 18:27:11 -0500 Subject: [PATCH] 1166 - 'Quay Enterprise' to 'Red Hat Quay' --- CHANGELOG.md | 6 ++-- README.md | 2 +- config.py | 4 +-- config_app/README.md | 2 +- .../config_endpoints/api/kube_endpoints.py | 2 +- config_app/config_util/k8saccessor.py | 4 +-- config_app/docs/initial_setup.md | 24 +++++++------- config_app/docs/kube_setup.md | 22 ++++++------- .../download-tarball-modal.component.html | 2 +- .../kube-deploy-modal.component.ts | 2 +- .../core-config-setup/config-setup-tool.html | 6 ++-- config_app/js/setup/setup.component.js | 2 +- config_app/js/setup/setup.html | 2 +- static/directives/plans-display.html | 32 +++++++++---------- static/directives/service-keys-manager.html | 2 +- static/directives/tour-content.html | 2 +- static/js/pages/incomplete-setup.js | 4 +-- static/js/pages/superuser.js | 4 +-- static/partials/incomplete-setup.html | 2 +- static/partials/super-user.html | 2 +- util/config/configdocs/html_output.py | 2 +- util/config/configdocs/schema.html | 6 ++-- util/config/provider/k8sprovider.py | 2 +- util/config/schema.py | 4 +-- 24 files changed, 71 insertions(+), 71 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f48a59ef4..101691e81 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -228,9 +228,9 @@ ### v2.1.0 -**IMPORTANT NOTE FOR POSTGRES USERS:** This release contains a migration which adds full-text searching capabilities to Quay Enterprise. In order to support this feature, the migration will attempt to create the `pg_trgm` extension in the database. This operation requires **superuser access** to run and requires the extension to be installed. See https://coreos.com/quay-enterprise/docs/latest/postgres-additional-modules.html for more information on installing the extension. +**IMPORTANT NOTE FOR POSTGRES USERS:** This release contains a migration which adds full-text searching capabilities to Red Hat Quay. In order to support this feature, the migration will attempt to create the `pg_trgm` extension in the database. This operation requires **superuser access** to run and requires the extension to be installed. See https://coreos.com/quay-enterprise/docs/latest/postgres-additional-modules.html for more information on installing the extension. -If the user given to Quay Enterprise is not a superuser, please temporarily grant superuser access to the Quay Enterprise user in the database (or change the user in config) **before** upgrading. +If the user given to Red Hat Quay is not a superuser, please temporarily grant superuser access to the Red Hat Quay user in the database (or change the user in config) **before** upgrading. - Added: Full text search support (#2272) - Added: OIDC support (#2300, #2348) @@ -638,7 +638,7 @@ In order to upgrade to this version, your cluster must contain a valid license, ### v1.13.0 -- Added new Quay Enterprise rebranding (#723, #738, #735, #745, #746, #748, #747, #751) +- Added new Red Hat Quay rebranding (#723, #738, #735, #745, #746, #748, #747, #751) - Added a styled 404 page (#683) - Hid the run button from users that haven't created a trigger (#727) - Added timeouts to calls to GitLab, Bitbucket, GitHub APIs (#636, #633, #631, #722) diff --git a/README.md b/README.md index a3f8d6a7a..ec1bf4f64 100644 --- a/README.md +++ b/README.md @@ -363,7 +363,7 @@ docker build -t $QUAY_TAG --build-arg RUN_TESTS=true . ## Documentation -* [Quay Enterprise Documentation](https://tectonic.com/quay-enterprise/docs/latest) +* [Red Hat Quay Documentation](https://tectonic.com/quay-enterprise/docs/latest) * [Quay.io Documentation](https://docs.quay.io) ### Architecture at a Glance diff --git a/config.py b/config.py index a0af03c77..6352b8356 100644 --- a/config.py +++ b/config.py @@ -87,8 +87,8 @@ class DefaultConfig(ImmutableConfig): PREFERRED_URL_SCHEME = 'http' SERVER_HOSTNAME = 'localhost:5000' - REGISTRY_TITLE = 'Quay Enterprise' - REGISTRY_TITLE_SHORT = 'Quay Enterprise' + REGISTRY_TITLE = 'Red Hat Quay' + REGISTRY_TITLE_SHORT = 'Red Hat Quay' CONTACT_INFO = [ 'mailto:support@quay.io', diff --git a/config_app/README.md b/config_app/README.md index 381dd268a..87f6e6fb0 100644 --- a/config_app/README.md +++ b/config_app/README.md @@ -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. diff --git a/config_app/config_endpoints/api/kube_endpoints.py b/config_app/config_endpoints/api/kube_endpoints.py index 6e22169a6..a7143412d 100644 --- a/config_app/config_endpoints/api/kube_endpoints.py +++ b/config_app/config_endpoints/api/kube_endpoints.py @@ -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', diff --git a/config_app/config_util/k8saccessor.py b/config_app/config_util/k8saccessor.py index 46fe4b83f..dd115681b 100644 --- a/config_app/config_util/k8saccessor.py +++ b/config_app/config_util/k8saccessor.py @@ -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) diff --git a/config_app/docs/initial_setup.md b/config_app/docs/initial_setup.md index d1236471f..70548697e 100644 --- a/config_app/docs/initial_setup.md +++ b/config_app/docs/initial_setup.md @@ -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") -Quay Enterprise Configuration Tool +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. -Quay Enterprise Load Configuration +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. diff --git a/config_app/docs/kube_setup.md b/config_app/docs/kube_setup.md index 9f6429ce7..72529b2e9 100644 --- a/config_app/docs/kube_setup.md +++ b/config_app/docs/kube_setup.md @@ -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). diff --git a/config_app/js/components/download-tarball-modal/download-tarball-modal.component.html b/config_app/js/components/download-tarball-modal/download-tarball-modal.component.html index 3eb032fab..1d58573ab 100644 --- a/config_app/js/components/download-tarball-modal/download-tarball-modal.component.html +++ b/config_app/js/components/download-tarball-modal/download-tarball-modal.component.html @@ -18,7 +18,7 @@
- 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 see the docs. diff --git a/config_app/js/components/kube-deploy-modal/kube-deploy-modal.component.ts b/config_app/js/components/kube-deploy-modal/kube-deploy-modal.component.ts index fdeb1ed3f..ae63ea569 100644 --- a/config_app/js/components/kube-deploy-modal/kube-deploy-modal.component.ts +++ b/config_app/js/components/kube-deploy-modal/kube-deploy-modal.component.ts @@ -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()}`; }) } diff --git a/config_app/js/core-config-setup/config-setup-tool.html b/config_app/js/core-config-setup/config-setup-tool.html index f043fe9fc..5fd63c5d4 100644 --- a/config_app/js/core-config-setup/config-setup-tool.html +++ b/config_app/js/core-config-setup/config-setup-tool.html @@ -70,7 +70,7 @@ TLS: @@ -80,7 +80,7 @@
- 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. This option is not recommended for simple setups. Please contact support if you encounter problems while using this option.
@@ -495,7 +495,7 @@ pattern="http(s)?://.+">
The HTTP URL at which the torrents should be announced. A JWT-compatible tracker such as Chihaya must be run to ensure proper security. Documentation on running Chihaya with - this support can be found at Running Chihaya for Quay Enterprise. + this support can be found at Running Chihaya for Red Hat Quay.
diff --git a/config_app/js/setup/setup.component.js b/config_app/js/setup/setup.component.js index c945b263c..65a076f31 100644 --- a/config_app/js/setup/setup.component.js +++ b/config_app/js/setup/setup.component.js @@ -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', () => { diff --git a/config_app/js/setup/setup.html b/config_app/js/setup/setup.html index 5548e52f5..7b989804f 100644 --- a/config_app/js/setup/setup.html +++ b/config_app/js/setup/setup.html @@ -4,7 +4,7 @@
- Quay Enterprise Setup + Red Hat Quay Setup
diff --git a/static/directives/plans-display.html b/static/directives/plans-display.html index 95b9d4f60..2283467a1 100644 --- a/static/directives/plans-display.html +++ b/static/directives/plans-display.html @@ -351,7 +351,7 @@ Can I change my plan? -

Yes, you can change your plan at any time and your account will be pro-rated for the difference. For large organizations, Quay Enterprise offers unlimited users and repos.

+

Yes, you can change your plan at any time and your account will be pro-rated for the difference. For large organizations, Red Hat Quay offers unlimited users and repos.

Do you offer special plans for business or academic institutions? @@ -404,14 +404,14 @@
- Quay Enterprise System - Quay Enterprise System + Red Hat Quay System + Red Hat Quay System
Highly available installation with geo-replication
-
Ready to try Quay Enterprise?
+
Ready to try Red Hat Quay?
- Learn more about Quay Enterprise + Learn more about Red Hat Quay
diff --git a/static/js/pages/incomplete-setup.js b/static/js/pages/incomplete-setup.js index b33d5f3cc..40ef3eb0c 100644 --- a/static/js/pages/incomplete-setup.js +++ b/static/js/pages/incomplete-setup.js @@ -6,7 +6,7 @@ pages.create('incomplete-setup', 'incomplete-setup.html', IncompleteSetupCtrl, { 'newLayout': true, - 'title': 'Quay Enterprise Setup Incomplete' + 'title': 'Red Hat Quay Setup Incomplete' }) }]); @@ -65,7 +65,7 @@ if (window.__kubernetes_namespace) { title = "Configuration Secret Missing"; - message = `It looks like the Quay Enterprise secret is not present in the namespace ${window.__kubernetes_namespace}.` + + message = `It looks like the Red Hat Quay secret is not present in the namespace ${window.__kubernetes_namespace}.` + "
Please double-check that the secret exists, or " + "" + "refer to the Setup Guide"; diff --git a/static/js/pages/superuser.js b/static/js/pages/superuser.js index 6663b9335..72b231cd0 100644 --- a/static/js/pages/superuser.js +++ b/static/js/pages/superuser.js @@ -1,12 +1,12 @@ (function() { /** - * The superuser admin page provides a new management UI for Quay Enterprise. + * The superuser admin page provides a new management UI for Red Hat Quay. */ angular.module('quayPages').config(['pages', function(pages) { pages.create('superuser', 'super-user.html', SuperuserCtrl, { 'newLayout': true, - 'title': 'Quay Enterprise Management' + 'title': 'Red Hat Quay Management' }) }]); diff --git a/static/partials/incomplete-setup.html b/static/partials/incomplete-setup.html index 70d38a88f..e96791ea0 100644 --- a/static/partials/incomplete-setup.html +++ b/static/partials/incomplete-setup.html @@ -3,7 +3,7 @@
- Quay Enterprise Setup Incomplete + Red Hat Quay Setup Incomplete
diff --git a/static/partials/super-user.html b/static/partials/super-user.html index a70db4a9e..fa4039b95 100644 --- a/static/partials/super-user.html +++ b/static/partials/super-user.html @@ -19,7 +19,7 @@
- Quay Enterprise Management + Red Hat Quay Management
diff --git a/util/config/configdocs/html_output.py b/util/config/configdocs/html_output.py index 35ccf792b..6b0cad921 100644 --- a/util/config/configdocs/html_output.py +++ b/util/config/configdocs/html_output.py @@ -22,7 +22,7 @@ class HtmlOutput: #output += '

{}

\n'.format(root_item['title']) #output += '

{}

\n'.format(root_item['title']) - output += "Schema for Quay Enterprise" + output += "Schema for Red Hat Quay" output += '
    \n' last_level = 0 diff --git a/util/config/configdocs/schema.html b/util/config/configdocs/schema.html index f0dc6041a..02fffab2e 100644 --- a/util/config/configdocs/schema.html +++ b/util/config/configdocs/schema.html @@ -4,7 +4,7 @@ -Schema for Quay Enterprise
      +Schema for Red Hat Quay
      • AUTHENTICATION_TYPE
        [string]
        @@ -970,7 +970,7 @@ Schema for Quay Enterprise
          -
          If specified, the long-form title for the registry. Defaults to `Quay Enterprise`.
          +
          If specified, the long-form title for the registry. Defaults to `Red Hat Quay`.
          Example: Corp Container Service
          @@ -980,7 +980,7 @@ Schema for Quay Enterprise
            -
            If specified, the short-form title for the registry. Defaults to `Quay Enterprise`.
            +
            If specified, the short-form title for the registry. Defaults to `Red Hat Quay`.
            Example: CCS
            diff --git a/util/config/provider/k8sprovider.py b/util/config/provider/k8sprovider.py index f0cef9c23..14bf99c4b 100644 --- a/util/config/provider/k8sprovider.py +++ b/util/config/provider/k8sprovider.py @@ -111,7 +111,7 @@ class KubernetesConfigProvider(BaseFileProvider): 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' % (QE_NAMESPACE) response = self._execute_k8s_api('GET', namespace_url) diff --git a/util/config/schema.py b/util/config/schema.py index 2e5c77df4..bd800048a 100644 --- a/util/config/schema.py +++ b/util/config/schema.py @@ -132,12 +132,12 @@ CONFIG_SCHEMA = { # User-visible configuration. 'REGISTRY_TITLE': { 'type': 'string', - 'description': 'If specified, the long-form title for the registry. Defaults to `Quay Enterprise`.', + 'description': 'If specified, the long-form title for the registry. Defaults to `Red Hat Quay`.', 'x-example': 'Corp Container Service', }, 'REGISTRY_TITLE_SHORT': { 'type': 'string', - 'description': 'If specified, the short-form title for the registry. Defaults to `Quay Enterprise`.', + 'description': 'If specified, the short-form title for the registry. Defaults to `Red Hat Quay`.', 'x-example': 'CCS', }, 'CONTACT_INFO': {