Skip to content

Commit 5f53996

Browse files
wethinkagiledmessergabriel-rh
authored
PROJQUAY-1854 Document various storage engine setups for the Quay operator (#171)
* Expanded Quay Schema to reflect more Storage Providers * merge with master * Remove IntelliJ files * Small Grammar Fix * Update modules/con_schema.adoc Co-authored-by: Daniel Messer <[email protected]> * Update con_schema.adoc Fix formatting for storage config Co-authored-by: Daniel Messer <[email protected]> Co-authored-by: Gabriel McGoldrick <[email protected]>
1 parent 1c272fd commit 5f53996

File tree

2 files changed

+79
-2
lines changed

2 files changed

+79
-2
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
dist
22
build/
33
.DS_Store
4+
.idea/

modules/con_schema.adoc

+78-2
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,84 @@ USER_EVENTS_REDIS
9999
** **Unique Items**: True
100100
** **Reference**: https://coreos.com/quay-enterprise/docs/latest/direct-oauth.html
101101
*** **array item** [string]
102-
* **DISTRIBUTED_STORAGE_CONFIG** [object] required: Configuration for storage engine(s) to use in {productname}. Each key is a unique ID for a storage engine, with the value being a tuple of the type and configuration for that engine.
103-
** **Example**: `{"local_storage": ["LocalStorage", {"storage_path": "some/path/"}]}`
102+
* **DISTRIBUTED_STORAGE_CONFIG** [object] required: Configuration for storage engine(s) to use in {productname}. Each key represents an unique identifier for a storage engine. The value consists of a tuple of (key, value) forming an object describing the storage engine parameters.
103+
104+
** ** OCS / Noobaa**:
105+
+
106+
```
107+
{"rhocsStorage": ["RHOCSStorage",
108+
{"access_key":"access_key"},
109+
{"secret_key":"secret_key"},
110+
{"bucket_name":"quay-datastore-9b2108a3-29f5-43f2-a9d5-2872174f9a56"},
111+
{"hostname":"s3.openshift-storage.svc.cluster.local"},
112+
{"is_secure":"true"},
113+
{"port":"443"},
114+
{"storage_path":"/datastorage/registry"}
115+
]}
116+
```
117+
** **Ceph / RadosGW Storage / Hitachi HCP**:
118+
+
119+
```
120+
{"radosGWStorage": ["RadosGWStorage",
121+
{"access_key": "access_key"},
122+
{"secret_key": "secret_key"},
123+
{"bucket_name": "quay"},
124+
{"hostname": "hostname"},
125+
{"is_secure": "false"},
126+
{"port": "443"},
127+
{"storage_path": "/datastorage/registry"}
128+
]}
129+
```
130+
131+
** **AWS S3 Storage**:
132+
+
133+
```
134+
{"s3Storage": ["S3Storage",
135+
{"host": "s3.ap-southeast-2.amazonaws.com"},
136+
{"s3_access_key": "/datastorage/registry"},
137+
{"s3_bucket": "/datastorage/registry"},
138+
{"s3_secret_key": "/datastorage/registry"},
139+
{"storage_path": "/datastorage/registry"}
140+
]}
141+
```
142+
143+
** **Azure Storage**:
144+
+
145+
```
146+
{"azureStorage": ["AzureStorage",
147+
{"azure_account_name": "azure_account_name"},
148+
{"azure_account_key": "some/path/"},
149+
{"azure_container": "azure_container"},
150+
{"sas_token": "some/path/"},
151+
{"storage_path": "/datastorage/registry"}
152+
]}
153+
```
154+
155+
** **Google Cloud Storage**:
156+
+
157+
```
158+
{"googleCloudStorage": ["GoogleCloudStorage",
159+
{"access_key": "access_key"},
160+
{"secret_key": "secret_key"},
161+
{"bucket_name": "bucket_name"},
162+
{"storage_path": "/datastorage/registry"}
163+
]}
164+
```
165+
166+
** **Swift Storage**:
167+
+
168+
```
169+
{"swiftStorage": ["SwiftStorage",
170+
{"swift_user":"user"},
171+
{"swift_password":"password"},
172+
{"swift_container":"quay"},
173+
{"auth_url": "https://example.org/swift/v1/quay"},
174+
{"auth_version": "1"},
175+
{"ca_cert_path":"/conf/stack/swift.cert"},
176+
{"storage_path":"/datastorage/registry"}
177+
]}
178+
```
179+
104180
* **DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS** [array]: The list of storage engine(s) (by ID in DISTRIBUTED_STORAGE_CONFIG) whose images should be fully replicated, by default, to all other storage engines.
105181
** **Min Items**: None
106182
** **Example**: `s3_us_east, s3_us_west`

0 commit comments

Comments
 (0)