Skip to content

Commit feb97c0

Browse files
authored
improve documentation for TNG Quay Operator (quay#104)
1 parent c1585be commit feb97c0

File tree

4 files changed

+199
-150
lines changed

4 files changed

+199
-150
lines changed

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11

22
build:
3-
@podman run -it --rm --name asciidoctor --detach -v $(CURDIR):/documents/:z asciidoctor/docker-asciidoctor
4-
@-podman exec -it asciidoctor bash -c "source build_docs"
5-
@podman kill asciidoctor
3+
@docker run -it --rm --name asciidoctor --detach -v $(CURDIR):/documents/:z asciidoctor/docker-asciidoctor
4+
@-docker exec -it asciidoctor bash -c "source build_docs"
5+
@docker kill asciidoctor
66

77
view:
88
xdg-open file://$(CURDIR)/dist/welcome.html

deploy_quay_on_openshift_op_tng/master.adoc

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,15 @@ include::modules/attributes.adoc[]
33
[id='deploy-quay-on-openshift']
44
= Deploy {productname} on OpenShift with the Quay Operator
55

6-
{productname} is an enterprise-quality container registry. Use {productname} to build and
7-
store container images, then make them available to deploy across your enterprise.
6+
{productname} is an enterprise-quality container registry. Use {productname} to build and store container images, then make them available to deploy across your enterprise.
87

9-
The Quay Operator provides a simple method to deploy and manage a {productname} cluster.
10-
This is the preferred procedure for deploying {productname} on OpenShift and is covered in this guide.
8+
The Quay Operator provides a simple method to deploy and manage a {productname} cluster. This is the preferred procedure for deploying {productname} on OpenShift and is covered in this guide.
119

1210
Note that this version of the Quay Operator has been completely rewritten and differs substantially from earlier versions. Please review this documentation carefully.
1311
ifeval::["{productname}" == "Project Quay"]
1412
If you are looking for documentation for prior versions of the Quay Operator, please xref:deploy_quay_on_openshift_op.adoc[check here.]
1513
endif::[]
1614

17-
include::modules/con_quay_intro.adoc[leveloffset=+1]
18-
1915
include::modules/con_quay_openshift_prereq.adoc[leveloffset=+1]
2016

2117
include::modules/proc_deploy-quay-openshift-operator-tng.adoc[leveloffset=+1]

modules/con_quay_openshift_prereq.adoc

Lines changed: 3 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,46 +2,15 @@
22

33
= Prerequisites for {productname} on OpenShift
44

5-
Here are a few things you need to know before you begin
6-
the {productname} on OpenShift deployment:
5+
Here are a few things you need to know before you begin the {productname} Operator on OpenShift deployment:
76

8-
* *OpenShift cluster*: You need a privileged account to an OpenShift 4.2 or later
9-
cluster on which to deploy
10-
the {productname}. That account must have the ability to create namespaces at the cluster scope.
7+
* *OpenShift cluster*: You need a privileged account to an OpenShift 4.5 or later cluster on which to deploy the {productname} Operator. That account must have the ability to create namespaces at the cluster scope.
118

12-
* *Storage*: AWS cloud storage is used as an example in the following procedure.
13-
As an alternative, you can create Ceph cloud storage using steps
14-
from the link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/deploy_red_hat_quay_-_high_availability/#set_up_ceph[Set up Ceph] section of the high availability {productname} deployment guide.
15-
The following is a list of other supported cloud storage:
9+
* *Object Storage*: By default, the {productname} Operator uses the `ObjectBucketClaim` Kubernetes API to provision object storage. Consuming this API decouples the Operator from any vendor-specific implementation. OpenShift Container Storage provides this API via its NooBaa component, which will be used in this example. Otherwise, {productname} can be manually configured to use any of the following supported cloud storage options:
1610

1711
** Amazon S3 (see link:https://access.redhat.com/solutions/3680151[S3 IAM Bucket Policy] for details on configuring an S3 bucket policy for {productname})
1812
** Azure Blob Storage
1913
** Google Cloud Storage
2014
** Ceph Object Gateway (RADOS)
2115
** OpenStack Swift
2216
** CloudFront + S3
23-
** OpenShift Container Storage (NooBaa S3 Storage). (See link:https://access.redhat.com/articles/4356091[Configuring Red Hat OpenShift Container Storage for Red Hat Quay])
24-
25-
* *Services*: The OpenShift cluster must have enough capacity to run
26-
the following containerized services:
27-
28-
** *Database*: We recommend you use an enterprise-quality database for production use of {productname}.
29-
PostgreSQL is used as an example in this document. Other options include:
30-
31-
*** Crunchy Data PostgreSQL Operator: Although not supported directly by Red Hat,
32-
the link:https://access.crunchydata.com/documentation/postgres-operator/latest/[CrunchDB Operator]
33-
is available from link:https://www.crunchydata.com/[Crunchy Data] for use with {productname}.
34-
If you take this route, you should have a support contract with Crunchy Data and
35-
work directly with them for usage guidance or issues relating to the operator and their database.
36-
37-
*** If your organization already has a high-availability (HA) database, you can use that database
38-
with {productname}. See the
39-
link:https://access.redhat.com/support/policy/updates/rhquay/policies[{productname} Support Policy]
40-
for details on support for third-party databases and other components.
41-
42-
** *Key-value database*: Redis is used to serve live builder logs and {productname}
43-
tutorial content to your {productname} configuration.
44-
45-
** *{productname}*: The quay container provides the features to manage the {productname} registry.
46-
47-
** *Clair*: The clair-jwt container provides Clair scanning services for the registry.

0 commit comments

Comments
 (0)