Skip to content

Commit 6f0a589

Browse files
committed
docs: create Quay repositories with "e2e run"
The "e2e run" target also creates all the repositories for the user, and then they only have to make them public. Adding a note as an alternative to manage those repositories in case the user wants to follow that path instead.
1 parent 9432f8b commit 6f0a589

File tree

2 files changed

+32
-40
lines changed

2 files changed

+32
-40
lines changed

CRC.adoc

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ been disabled by default it is still quite demanding in terms of system resource
1010
recommended that it be installed on a machine that has at least 32GB of memory.
1111

1212
This guide will walk through the steps of downloading and installing OpenShift local, and running the e2e tests against
13-
local Codeready Toolchain `host-operator` and `member-operator` repositories.
13+
local CodeReady Toolchain `host-operator` and `member-operator` repositories.
1414

1515
=== Install the required tools
1616

@@ -61,9 +61,9 @@ crc config set enable-cluster-monitoring true
6161
6262
# A minimum of 14GB of virtual machine memory is required to run by default, so it is recommended to change that
6363
# setting. Tweaking the CPUs and disk size is optional, but also recommended to avoid having issues down the line.
64-
crc config set cpus 8
64+
crc config set cpus 6
6565
crc config set disk-size 50
66-
crc config set memory 14500 # or 20000 for 20GB
66+
crc config set memory 14500 # in MB. You can also use 20000 for 20GB, to be safer.
6767
----
6868

6969
Now you can go ahead and start the cluster. The first time you will need to provide the pull secret you were presented
@@ -81,31 +81,12 @@ able to run the tests.
8181
=== Prepare the projects
8282
==== Creating the Quay repositories and making them public
8383

84-
The end-to-end local tests build and push images to the Quay registry, so in order to avoid having issues with your
85-
local OpenShift cluster being unable to pull them from a non-public repository, you need to create those repositories
86-
and make them "public". Follow the following steps for that:
87-
88-
1. Log in to https://quay.io.
89-
2. Go to the repository section, or click on the following link: https://quay.io/repository.
90-
3. Click on the "Create new repository" button.
91-
4. Select your personal namespace if it is not already selected for you, give the repository an appropriate name, and
92-
choose "Public" as the repository's visibility.
93-
5. Click on "Create".
94-
95-
The repositories that you need to create and mark public need to be named as follows:
96-
97-
* `host-operator-bundle`
98-
* `host-operator-index`
99-
* `host-operator`
100-
* `member-operator-bundle`
101-
* `member-operator-index`
102-
* `member-operator-webhook`
103-
* `member-operator`
104-
* `registration-service`
84+
Please follow the steps in the xref:quay.adoc["Configure your Quay account for dev deployment"] document to set up the
85+
Quay repositories, and then come back to this guide.
10586

10687
==== Cloning the operator repositories
10788

108-
In order to run the tests, you need to clone the repositories listed below *at the same directory level* as the
89+
In order to run the local tests, you need to clone the repositories listed below *at the same directory level* as the
10990
`toolchain-e2e` repository, which should result in a directory structure like this:
11091

11192
[source,text]
@@ -121,6 +102,9 @@ In order to run the tests, you need to clone the repositories listed below *at t
121102
* https://github.com/codeready-toolchain/member-operator[member-operator]
122103
* https://github.com/codeready-toolchain/registration-service[registration-service]
123104

105+
Also, if you already had them cloned, make sure you have the latest changes fetched in order to have the latest
106+
bug fixes and tests in your local repositories.
107+
124108
=== Final steps and running the tests
125109

126110
After some time has passed, the local OpenShift cluster might be ready to work with. The terminal should show an output

quay.adoc

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
11
== Configure your Quay account for dev deployment
22

3-
There is a set of images that is built and pushed to quay repositories while deploying local versions of Toolchain (Sandbox) operators to OpenShift cluster. Please make sure that the repositories exist in your quay.io account.
3+
There is a set of images that is built and pushed to quay repositories while deploying local versions of Toolchain
4+
(Sandbox) operators to OpenShift cluster. Please make sure that the repositories exist in your Quay.io account.
45

56
=== Repositories
6-
. Register for a quay.io account if you don't have one
7-
. Make sure you have set the _QUAY_NAMESPACE_ variable: +
8-
`export QUAY_NAMESPACE=<quay-username>`
9-
. Log in to quay.io using +
10-
`podman login quay.io`
11-
* Make sure that these repositories exist on quay.io and the visibility is set to `public` for all of them:
12-
* https://quay.io/repository/<quay-username>/host-operator
13-
* https://quay.io/repository/<quay-username>/host-operator-bundle
14-
* https://quay.io/repository/<quay-username>/host-operator-index
15-
* https://quay.io/repository/<quay-username>/member-operator
16-
* https://quay.io/repository/<quay-username>/member-operator-webhook
17-
* https://quay.io/repository/<quay-username>/member-operator-bundle
18-
* https://quay.io/repository/<quay-username>/member-operator-index
19-
* https://quay.io/repository/<quay-username>/registration-service
7+
. Register for a quay.io account if you don't have one and log in to the account.
8+
. Go to the repository section, or click on the following link: https://quay.io/repository.
9+
. Click on the "Create new repository" button.
10+
. Select your personal namespace if it is not already selected for you, give the repository an appropriate name, and
11+
choose "Public" as the repository's visibility.
12+
. Click on "Create".
13+
14+
Also, make sure that:
15+
16+
. You have set the `QUAY_NAMESPACE` environment variable so that any commands or tests you run use your personal Quay
17+
repositories: `export QUAY_NAMESPACE=<quay-username>`
18+
. You are logged in to your Quay.io account in Podman too with `podman login quay.io` for the same previous reason.
19+
. You end up with the following *public* repositories in Quay:
20+
.. https://quay.io/repository/<quay-username>/host-operator
21+
.. https://quay.io/repository/<quay-username>/host-operator-bundle
22+
.. https://quay.io/repository/<quay-username>/host-operator-index
23+
.. https://quay.io/repository/<quay-username>/member-operator
24+
.. https://quay.io/repository/<quay-username>/member-operator-webhook
25+
.. https://quay.io/repository/<quay-username>/member-operator-bundle
26+
.. https://quay.io/repository/<quay-username>/member-operator-index
27+
.. https://quay.io/repository/<quay-username>/registration-service
2028

2129

2230
=== Public visibility

0 commit comments

Comments
 (0)