Skip to content

Commit 4fcf90f

Browse files
stevsmitSteven Smith
andauthored
Adds disable_pushes configuration field to guide (quay#1124)
Co-authored-by: Steven Smith <[email protected]>
1 parent 6f61038 commit 4fcf90f

7 files changed

+64
-7
lines changed

modules/config-fields-misc.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,8 @@
9494
+
9595
**Default:** False
9696

97+
|*DISABLE_PUSHES* |Boolean | Disables pushes of new content to the registry while retaining all other functionality. Differs from `read-only` mode because database is not set as `read-only`. When `DISABLE_PUSHES` is set to `true`, the {productname} garbage collector is disabled. As a result, when `PERMANENTLY_DELETE_TAGS` is enabled, using the {productname} UI to permanently delete a tag does not result in the immediate deletion of a tag. Instead, the image stays in the backend storage until `DISABLE_PUSHES` is set to `false`, which re-enables the garbage collector. {productname} administrators should be aware of this caveat when using `DISABLE_PUSHES` and `PERMANENTLY_DELETE_TAGS` together. +
98+
+
99+
**Default:** False
100+
97101
|===

modules/config-fields-storage-features.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ The following table describes the image storage features for {productname}:
1717
| **FEATURE_STORAGE_REPLICATION** | Boolean | Whether to automatically replicate between storage engines. +
1818
+
1919
**Default:** `false`
20+
2021
|===

modules/config-fields-storage-fields.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,5 @@ The following table describes the image storage configuration fields for {produc
2525
**Example**: `100G` +
2626
+
2727
**Default:** `20G`
28+
2829
|===

modules/config-updates-313.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
:_content-type: REFERENCE
2+
[id="config-updates-313"]
3+
= Configuration updates for {productname} 3.13
4+
5+
The following sections detail new configuration fields added in {productname} 3.13.
6+
7+
[id="disabling-pushes-configuration-field"]
8+
== Disabling pushes to the {productname} registry
9+
10+
The following configuration field has been added to disable the push of new content to the registry.
11+
12+
|===
13+
| Field | Type | Description
14+
15+
|*DISABLE_PUSHES* |Boolean | Disables pushes of new content to the registry while retaining all other functionality. Differs from `read-only` mode because database is not set as `read-only`. When `DISABLE_PUSHES` is set to `true`, the {productname} garbage collector is disabled. As a result, when `PERMANENTLY_DELETE_TAGS` is enabled, using the {productname} UI to permanently delete a tag does not result in the immediate deletion of a tag. Instead, the image stays in the backend storage until `DISABLE_PUSHES` is set to `false`, which re-enables the garbage collector. {productname} administrators should be aware of this caveat when using `DISABLE_PUSHES` and `PERMANENTLY_DELETE_TAGS` together. +
16+
+
17+
**Default:** False
18+
|===
19+
20+
.Example DISABLE_PUSHES configuration field
21+
[source,yaml]
22+
----
23+
# ...
24+
DISABLE_PUSHES: true
25+
# ...
26+
----

modules/optional-enabling-read-only-mode-backup-restore-ocp.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ Enabling read-only mode for your {productname-ocp} deployment allows you to mana
66

77
When backing up and restoring, you are required to scale down your {productname-ocp} deployment. This results in service unavailability during the backup period which, in some cases, might be unacceptable. Enabling read-only mode ensures service availability during the backup and restore procedure for {productname-ocp} deployments.
88

9+
[NOTE]
10+
====
11+
In some cases, a read-only option for {productname} is not possible since it requires inserting a service key and other manual configuration changes. As an alternative to read-only mode, {productname} administrators might consider enabling the `DISABLE_PUSHES` feature. When this field is set to `true`, users are unable to push images or image tags to the registry when using the CLI. Enabling `DISABLE_PUSHES` differs from `read-only` mode because the database is not set as `read-only` when it is enabled.
12+
13+
This field might be useful in some situations such as when {productname} administrators want to calculate their registry's quota and disable image pushing until after calculation has completed. With this method, administrators can avoid putting putting the whole registry in `read-only` mode, which affects the database, so that most operations can still be done.
14+
15+
For information about enabling this configuration field, see link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/configure_red_hat_quay/index#config-fields-misc[Miscellaneous configuration fields].
16+
====
17+
918
.Prerequisites
1019

1120
* If you are using {rhel} 7.x:

modules/optional-enabling-read-only-mode-backup-restore-standalone.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@
44

55
Enabling read-only mode for your {productname} deployment allows you to manage the registry's operations. {productname} administrators can enable read-only mode to restrict write access to the registry, which helps ensure data integrity, mitigate risks during maintenance windows, and provide a safeguard against unintended modifications to registry data. It also helps to ensure that your {productname} registry remains online and available to serve images to users.
66

7+
[NOTE]
8+
====
9+
In some cases, a read-only option for {productname} is not possible since it requires inserting a service key and other manual configuration changes. As an alternative to read-only mode, {productname} administrators might consider enabling the `DISABLE_PUSHES` feature. When this field is set to `true`, users are unable to push images or image tags to the registry when using the CLI. Enabling `DISABLE_PUSHES` differs from `read-only` mode because the database is not set as `read-only` when it is enabled.
10+
11+
This field might be useful in some situations such as when {productname} administrators want to calculate their registry's quota and disable image pushing until after calculation has completed. With this method, administrators can avoid putting putting the whole registry in `read-only` mode, which affects the database, so that most operations can still be done.
12+
13+
For information about enabling this configuration field, see link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/configure_red_hat_quay/index#config-fields-misc[Miscellaneous configuration fields].
14+
====
15+
716
.Prerequisites
817

918
* If you are using {rhel} 7.x:

modules/rn_3_13_0.adoc

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,21 +83,28 @@ For more information, see . . .
8383

8484
The following configuration fields have been added to {productname} {producty}.
8585

86-
[id="oauth-reassign-configuration-field"]
87-
=== OAuth access token reassignment configuration field
86+
[id="disable-pushes-configuration-field"]
87+
=== Disabling pushes to the {productname} registry configuration field
88+
89+
In some cases, a read-only option for {productname} is not possible since it requires inserting a service key and other manual configuration changes. With the release of {productname} 3.13, a new configuration field has been added: `DISABLE_PUSHES`.
90+
91+
When `DISABLE_PUSHES` is set to `true`, users are unable to push images or image tags to the registry when using the CLI. Most other registry operations continue as normal when this feature is enabled by using the {productname} UI. For example, changing tags, editing a repository, robot account creation and deletion, user creation, and so on are all possible by using the UI.
92+
93+
When `DISABLE_PUSHES` is set to `true`, the {productname} garbage collector is disabled. As a result, when `PERMANENTLY_DELETE_TAGS` is enabled, using the {productname} UI to permanently delete a tag does not result in the immediate deletion of a tag. Instead, the tag stays in the repository until `DISABLE_PUSHES` is set to `false`, which re-enables the garbage collector. {productname} administrators should be aware of this caveat when using `DISABLE_PUSHES` and `PERMANENTLY_DELETE_TAGS` together.
94+
95+
This field might be useful in some situations such as when {productname} administrators want to calculate their registry's quota and disable image pushing until after calculation has completed. With this method, administrators can avoid putting putting the whole registry in `read-only` mode, which affects the database, so that most operations can still be done.
8896

89-
The following configuration field has been added for reassigning OAuth access tokens:
9097
|===
91-
| Field | Type | Description
98+
| Field | Type | Description
9299

93-
| | |
100+
|*DISABLE_PUSHES* |Boolean | Disables pushes of new content to the registry while retaining all other functionality. Differs from `read-only` mode because database is not set as `read-only`. Defaults to `false`.
94101
|===
95102

96-
.Example YAML config field
103+
.Example DISABLE_PUSHES configuration field
97104
[source,yaml]
98105
----
99106
# ...
100-
yaml: true
107+
DISABLE_PUSHES: true
101108
# ...
102109
----
103110

0 commit comments

Comments
 (0)