Skip to content

Commit 901a091

Browse files
author
Steven Smith
committed
Adds docs for OMR version 2
1 parent f467443 commit 901a091

File tree

4 files changed

+51
-159
lines changed

4 files changed

+51
-159
lines changed

‎modules/mirror-registry-flags.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ The following flags are available for the _mirror registry for Red Hat OpenShift
1414
| `--initPassword` | The password of the init user created during Quay installation. Must be at least eight characters and contain no whitespace.
1515
|`--initUser string` | Shows the username of the initial user. Defaults to `init` if left unspecified.
1616
| `--no-color`, `-c` | Allows users to disable color sequences and propagate that to Ansible when running install, uninstall, and upgrade commands.
17-
| `--pgStorage` | The folder where Postgres persistent storage data is saved. Defaults to the `pg-storage` Podman volume. Root privileges are required to uninstall.
1817
| `--quayHostname` | The fully-qualified domain name of the mirror registry that clients will use to contact the registry. Equivalent to `SERVER_HOSTNAME` in the Quay `config.yaml`. Must resolve by DNS. Defaults to `<targetHostname>:8443` if left unspecified. ^[1]^
1918
| `--quayStorage` | The folder where Quay persistent storage data is saved. Defaults to the `quay-storage` Podman volume. Root privileges are required to uninstall.
2019
| `--quayRoot`, `-r` | The directory where container image layer and configuration data is saved, including `rootCA.key`, `rootCA.pem`, and `rootCA.srl` certificates. Defaults to `$HOME/quay-install` if left unspecified.
20+
| `--sqliteStorage` | The folder where SQLite database data is saved. Defaults to `sqlite-storage` Podman volume if not specified. Root is required to uninstall.
2121
| `--ssh-key`, `-k` | The path of your SSH identity key. Defaults to `~/.ssh/quay_installer` if left unspecified.
2222
| `--sslCert` | The path to the SSL/TLS public key / certificate. Defaults to `{quayRoot}/quay-config` and is auto-generated if left unspecified.
2323
| `--sslCheckSkip` | Skips the check for the certificate hostname against the `SERVER_HOSTNAME` in the `config.yaml` file. ^[2]^

‎modules/mirror-registry-localhost-update.adoc

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ This procedure explains how to update the _mirror registry for Red Hat OpenShift
1010

1111
[IMPORTANT]
1212
====
13-
When updating, there is intermittent downtime of your mirror registry, as it is restarted during the update process.
13+
When upgrading from version 1 to version 2, be aware of the following constraints:
14+
* The worker count is set to `1` because multiple writes are not allowed in SQLite.
15+
* You must not use the _mirror registry for Red{nbsp}Hat OpenShift_ user interface (UP).
16+
* Do not access the `sqlite-storage` Podman volume during the upgrade.
17+
* There is intermittent downtime of your mirror registry because it is restarted during the upgrade process.
18+
* PostgreSQL data is backed up under the `/$HOME/quay-instal/quay-postgres-backup/` directory for recovery.
1419
====
1520

1621
.Prerequisites
@@ -19,7 +24,7 @@ When updating, there is intermittent downtime of your mirror registry, as it is
1924
2025
.Procedure
2126

22-
* If you are upgrading the _mirror registry for Red Hat OpenShift_ from 1.2.z -> 1.3.0, and your installation directory is the default at `/etc/quay-install`, you can enter the following command:
27+
* If you are upgrading the _mirror registry for Red Hat OpenShift_ from 1.3 -> 2.y, and your installation directory is the default at `/etc/quay-install`, you can enter the following command:
2328
+
2429
[source,terminal]
2530
----
@@ -33,10 +38,16 @@ $ sudo ./mirror-registry upgrade -v
3338
* Users who upgrade _mirror registry for Red Hat OpenShift_ with the `./mirror-registry upgrade -v` flag must include the same credentials used when creating their mirror registry. For example, if you installed the _mirror registry for Red Hat OpenShift_ with `--quayHostname <host_example_com>` and `--quayRoot <example_directory_name>`, you must include that string to properly upgrade the mirror registry.
3439
====
3540
36-
* If you are upgrading the _mirror registry for Red Hat OpenShift_ from 1.2.z -> 1.3.0 and you used a specified directory in your 1.2.z deployment, you must pass in the new `--pgStorage` and `--quayStorage` flags. For example:
41+
* If you are upgrading _the mirror registry for Red Hat OpenShift_ from 1.3 -> 2.y and you used a custom quay configuration and storage directory in your 1.y deployment, you must pass in the `--quayRoot` and `--quayStorage` flags. For example:
3742
+
3843
[source,terminal]
3944
----
40-
$ sudo ./mirror-registry upgrade --quayHostname <host_example_com> --quayRoot <example_directory_name> --pgStorage <example_directory_name>/pg-data --quayStorage <example_directory_name>/quay-storage -v
45+
$ sudo ./mirror-registry upgrade --quayHostname <host_example_com> --quayRoot <example_directory_name> --quayStorage <example_directory_name>/quay-storage -v
4146
----
4247
48+
* If you are upgrading the _mirror registry for Red Hat OpenShift_ from 1.3 -> 2.y and want to specify a custom SQLite storage path, you must pass in the `--sqliteStorage` flag, for example:
49+
+
50+
[source,terminal]
51+
----
52+
$ sudo ./mirror-registry upgrade --sqliteStorage <example_directory_name>/quay-storage -v
53+
----

‎modules/mirror-registry-release-notes.adoc

Lines changed: 22 additions & 153 deletions
Original file line numberDiff line numberDiff line change
@@ -3,179 +3,48 @@
33
// * installing/disconnected_install/installing-mirroring-creating-registry.adoc
44

55
[id="mirror-registry-release-notes_{context}"]
6-
= Mirror registry for Red Hat OpenShift release notes
6+
= Mirror registry for Red{nbsp}Hat OpenShift release notes
77

8-
The _mirror registry for Red Hat OpenShift_ is a small and streamlined container registry that you can use as a target for mirroring the required container images of {product-title} for disconnected installations.
8+
The _mirror registry for Red{nbsp}Hat OpenShift_ is a small and streamlined container registry that you can use as a target for mirroring the required container images of {product-title} for disconnected installations.
99

10-
These release notes track the development of the _mirror registry for Red Hat OpenShift_ in {product-title}.
10+
These release notes track the development of the _mirror registry for Red{nbsp}Hat OpenShift_ in {product-title}.
1111

12-
[id="mirror-registry-release-notes-1-3_{context}"]
13-
== Mirror registry for Red Hat OpenShift 1.3 release notes
14-
15-
The following sections provide details for each 1.3.z release of the _mirror registry for Red Hat OpenShift_
16-
17-
[id="mirror-registry-for-openshift-1-3-11_{context}"]
18-
=== Mirror registry for Red Hat OpenShift 1.3.11
19-
20-
Issued: 2024-04-23
21-
22-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.15.
23-
24-
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
25-
26-
* link:https://access.redhat.com/errata/RHBA-2024:1758[RHBA-2024:1758 - mirror registry for Red Hat OpenShift 1.3.11]
27-
28-
[id="mirror-registry-for-openshift-1-3-10_{context}"]
29-
=== Mirror registry for Red Hat OpenShift 1.3.10
30-
31-
Issued: 2023-12-07
32-
33-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.14.
34-
35-
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
36-
37-
* link:https://access.redhat.com/errata/RHBA-2023:7628[RHBA-2023:7628 - mirror registry for Red Hat OpenShift 1.3.10]
38-
39-
[id="mirror-registry-for-openshift-1-3-9_{context}"]
40-
=== Mirror registry for Red Hat OpenShift 1.3.9
41-
42-
Issued: 2023-09-19
43-
44-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.12.
45-
46-
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
47-
48-
* link:https://access.redhat.com/errata/RHBA-2023:5241[RHBA-2023:5241 - mirror registry for Red Hat OpenShift 1.3.9]
49-
50-
[id="mirror-registry-for-openshift-1-3-8_{context}"]
51-
=== Mirror registry for Red Hat OpenShift 1.3.8
52-
53-
Issued: 2023-08-16
54-
55-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.11.
56-
57-
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
58-
59-
* link:https://access.redhat.com/errata/RHBA-2023:4622[RHBA-2023:4622 - mirror registry for Red Hat OpenShift 1.3.8]
60-
61-
[id="mirror-registry-for-openshift-1-3-7_{context}"]
62-
=== Mirror registry for Red Hat OpenShift 1.3.7
63-
64-
Issued: 2023-07-19
65-
66-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.10.
67-
68-
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
69-
70-
* link:https://access.redhat.com/errata/RHBA-2023:4087[RHBA-2023:4087 - mirror registry for Red Hat OpenShift 1.3.7]
71-
72-
[id="mirror-registry-for-openshift-1-3-6_{context}"]
73-
=== Mirror registry for Red Hat OpenShift 1.3.6
74-
75-
Issued: 2023-05-30
76-
77-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.8.
78-
79-
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
12+
[id="mirror-registry-release-notes-2-0_{context}"]
13+
== Mirror registry for Red{nbsp}Hat OpenShift 2.0 release notes
8014

81-
* link:https://access.redhat.com/errata/RHBA-2023:3302[RHBA-2023:3302 - mirror registry for Red Hat OpenShift 1.3.6]
15+
The following sections provide details for each 2.0 release of the mirror registry for Red{nbsp}Hat OpenShift
8216

83-
[id="mirror-registry-for-openshift-1-3-5_{context}"]
84-
=== Mirror registry for Red Hat OpenShift 1.3.5
17+
[id="mirror-registry-for-openshift-2-0-0_{context}"]
18+
=== Mirror registry for Red Hat OpenShift 2.0.0
8519

86-
Issued: 2023-05-18
20+
Issued: 03 September 2024
8721

88-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.7.
22+
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.12.0.
8923

9024
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
9125

92-
* link:https://access.redhat.com/errata/RHBA-2023:3225[RHBA-2023:3225 - mirror registry for Red Hat OpenShift 1.3.5]
26+
* link:https://access.redhat.com/errata/RHBA-2023:5277[RHBA-2023:5277 - mirror registry for Red Hat OpenShift 2.0.0]
9327

94-
[id="mirror-registry-for-openshift-1-3-4_{context}"]
95-
=== Mirror registry for Red Hat OpenShift 1.3.4
96-
97-
Issued: 2023-04-25
98-
99-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.6.
100-
101-
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
102-
103-
* link:https://access.redhat.com/errata/RHBA-2023:1914[RHBA-2023:1914 - mirror registry for Red Hat OpenShift 1.3.4]
104-
105-
[id="mirror-registry-for-openshift-1-3-3_{context}"]
106-
=== Mirror registry for Red Hat OpenShift 1.3.3
107-
108-
Issued: 2023-04-05
109-
110-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.5.
111-
112-
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
113-
114-
* link:https://access.redhat.com/errata/RHBA-2023:1528[RHBA-2023:1528 - mirror registry for Red Hat OpenShift 1.3.3]
115-
116-
[id="mirror-registry-for-openshift-1-3-2_{context}"]
117-
=== Mirror registry for Red Hat OpenShift 1.3.2
118-
119-
Issued: 2023-03-21
120-
121-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.4.
122-
123-
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
124-
125-
* link:https://access.redhat.com/errata/RHBA-2023:1376[RHBA-2023:1376 - mirror registry for Red Hat OpenShift 1.3.2]
126-
127-
[id="mirror-registry-for-openshift-1-3-1_{context}"]
128-
=== Mirror registry for Red Hat OpenShift 1.3.1
129-
130-
Issued: 2023-03-7
131-
132-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.3.
133-
134-
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
135-
136-
* link:https://access.redhat.com/errata/RHBA-2023:1086[RHBA-2023:1086 - mirror registry for Red Hat OpenShift 1.3.1]
137-
138-
[id="mirror-registry-for-openshift-1-3-0_{context}"]
139-
=== Mirror registry for Red Hat OpenShift 1.3.0
140-
141-
Issued: 2023-02-20
142-
143-
_Mirror registry for Red Hat OpenShift_ is now available with Red Hat Quay 3.8.1.
144-
145-
The following advisory is available for the _mirror registry for Red Hat OpenShift_:
146-
147-
* link:https://access.redhat.com/errata/RHBA-2023:0558[RHBA-2023:0558 - mirror registry for Red Hat OpenShift 1.3.0]
148-
149-
[id="mirror-registry-new-features-1-3-0_{context}"]
28+
[id="mirror-registry-new-features-2-0_{context}"]
15029
==== New features
15130

152-
* _Mirror registry for Red Hat OpenShift_ is now supported on {op-system-base-full} 9 installations.
153-
154-
* IPv6 support is now available on _mirror registry for Red Hat OpenShift_ local host installations.
31+
* With the release of _mirror registry for Red{nbsp}Hat OpenShift_, the internal database has been upgraded from PostgreSQL to SQLite. As a result, data is now stored on the `sqlite-storage` Podman volume by default, and the overall tarball size is reduced by 300 MB.
15532
+
156-
IPv6 is currently unsupported on _mirror registry for Red Hat OpenShift_ remote host installations.
157-
158-
* A new feature flag, `--quayStorage`, has been added. By specifying this flag, you can manually set the location for the Quay persistent storage.
33+
New installations use SQLite by default. Before upgrading to version 2.0, see "Updating mirror registry for Red Hat OpenShift from a local host" or "Updating mirror registry for Red Hat OpenShift from a remote host" depending on your environment.
15934

160-
* A new feature flag, `--pgStorage`, has been added. By specifying this flag, you can manually set the location for the Postgres persistent storage.
35+
* A new feature flag, `--sqliteStorage` has been added. With this flag, you can manually set the location where SQLite database data is saved.
16136

162-
* Previously, users were required to have root privileges (`sudo`) to install _mirror registry for Red Hat OpenShift_. With this update, `sudo` is no longer required to install _mirror registry for Red Hat OpenShift_.
163-
+
164-
When _mirror registry for Red Hat OpenShift_ was installed with `sudo`, an `/etc/quay-install` directory that contained installation files, local storage, and the configuration bundle was created. With the removal of the `sudo` requirement, installation files and the configuration bundle are now installed to `$HOME/quay-install`. Local storage, for example Postgres and Quay, are now stored in named volumes automatically created by Podman.
165-
+
166-
To override the default directories that these files are stored in, you can use the command line arguments for _mirror registry for Red Hat OpenShift_. For more information about _mirror registry for Red Hat OpenShift_ command line arguments, see "_Mirror registry for Red Hat OpenShift_ flags".
167-
168-
[id="mirror-registry-bug-fixes-1-3-0_{context}"]
169-
==== Bug fixes
37+
[id="mirror-registry-release-notes-1-3_{context}"]
38+
== Mirror registry for Red{nbsp}Hat OpenShift 1.3 release notes
17039

171-
* Previously, the following error could be returned when attempting to uninstall _mirror registry for Red Hat OpenShift_: `["Error: no container with name or ID \"quay-postgres\" found: no such container"], "stdout": "", "stdout_lines": []***`. With this update, the order that _mirror registry for Red Hat OpenShift_ services are stopped and uninstalled have been changed so that the error no longer occurs when uninstalling _mirror registry for Red Hat OpenShift_. For more information, see link:https://issues.redhat.com/browse/PROJQUAY-4629[*PROJQUAY-4629*].
40+
To view the _mirror registry for Red{nbsp}Hat OpenShift_ 1.3 release notes, see link:https://docs.openshift.com/container-platform/4.16/installing/disconnected_install/installing-mirroring-creating-registry.html#mirror-registry-release-notes-1-3_installing-mirroring-creating-registry[Mirror registry for Red{nbsp}Hat OpenShift 1.3 release notes].
17241

17342
[id="mirror-registry-release-notes-1-2_{context}"]
174-
== Mirror registry for Red Hat OpenShift 1.2 release notes
43+
== Mirror registry for Red{nbsp}Hat OpenShift 1.2 release notes
17544

176-
To view the _mirror registry for Red Hat OpenShift_ 1.2 release notes, see link:https://docs.openshift.com/container-platform/4.15/installing/disconnected_install/installing-mirroring-creating-registry.html#mirror-registry-release-notes-1-2_installing-mirroring-creating-registry[Mirror registry for Red Hat OpenShift 1.2 release notes].
45+
To view the _mirror registry for Red{nbsp}Hat OpenShift_ 1.2 release notes, see link:https://docs.openshift.com/container-platform/4.15/installing/disconnected_install/installing-mirroring-creating-registry.html#mirror-registry-release-notes-1-2_installing-mirroring-creating-registry[Mirror registry for Red{nbsp}Hat OpenShift 1.2 release notes].
17746

17847
[id="mirror-registry-release-notes-1-1_{context}"]
179-
== Mirror registry for Red Hat OpenShift 1.1 release notes
48+
== Mirror registry for Red{nbsp}Hat OpenShift 1.1 release notes
18049

181-
To view the _mirror registry for Red Hat OpenShift_ 1.1 release notes, see link:https://docs.openshift.com/container-platform/4.15/installing/disconnected_install/installing-mirroring-creating-registry.html#mirror-registry-release-notes-1-1_installing-mirroring-creating-registry[Mirror registry for Red Hat OpenShift 1.1 release notes].
50+
To view the _mirror registry for Red{nbsp}Hat OpenShift_ 1.1 release notes, see link:https://docs.openshift.com/container-platform/4.15/installing/disconnected_install/installing-mirroring-creating-registry.html#mirror-registry-release-notes-1-1_installing-mirroring-creating-registry[Mirror registry for Red Hat OpenShift 1.1 release notes].

‎modules/mirror-registry-remote-host-update.adoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ This procedure explains how to update the _mirror registry for Red Hat OpenShift
1010

1111
[IMPORTANT]
1212
====
13-
When updating, there is intermittent downtime of your mirror registry, as it is restarted during the update process.
13+
When upgrading from version 1 to version 2, be aware of the following constraints:
14+
* The worker count is set to `1` because multiple writes are not allowed in SQLite.
15+
* You must not use the _mirror registry for Red{nbsp}Hat OpenShift_ user interface (UP).
16+
* Do not access the `sqlite-storage` Podman volume during the upgrade.
17+
* There is intermittent downtime of your mirror registry because it is restarted during the upgrade process.
18+
* PostgreSQL data is backed up under the `/$HOME/quay-instal/quay-postgres-backup/` directory for recovery.
1419
====
1520

1621
.Prerequisites
@@ -30,3 +35,10 @@ $ ./mirror-registry upgrade -v --targetHostname <remote_host_url> --targetUserna
3035
====
3136
Users who upgrade the _mirror registry for Red Hat OpenShift_ with the `./mirror-registry upgrade -v` flag must include the same credentials used when creating their mirror registry. For example, if you installed the _mirror registry for Red Hat OpenShift_ with `--quayHostname <host_example_com>` and `--quayRoot <example_directory_name>`, you must include that string to properly upgrade the mirror registry.
3237
====
38+
39+
* If you are upgrading the _mirror registry for Red Hat OpenShift_ from 1.3 -> 2.y and want to specify a custom SQLite storage path, you must pass in the `--sqliteStorage` flag, for example:
40+
+
41+
[source,terminal]
42+
----
43+
$ ./mirror-registry upgrade -v --targetHostname <remote_host_url> --targetUsername <user_name> -k ~/.ssh/my_ssh_key --sqliteStorage <example_directory_name>/quay-storage
44+
----

0 commit comments

Comments
 (0)