Add registry storage configuration modules by bmcelvee · Pull Request #14390 · openshift/openshift-docs

bmcelvee · 2019-04-10T15:16:41Z

https://jira.coreos.com/browse/DEVEXP-278
https://jira.coreos.com/browse/DEVEXP-268
https://jira.coreos.com/browse/DEVEXP-267
https://jira.coreos.com/browse/OSDOCS-243

openshift-docs-preview-bot · 2019-04-10T15:19:45Z

The preview will be availble shortly at:

https://add-registry-storage-modules--ocpdocs.netlify.com/

dmage · 2019-04-11T15:47:00Z

image-registry-private-configuration shouldn't be modified by users. After today's scrum I'd say there are 2 options:

the cloud credentials are sufficient to create an S3 bucket, in this case the operator will do the storage configuration automatically;

the operator is not capable of creating S3 buckets, in this case the administrator should create an S3 bucket, setup a Bucket Lifecycle Policy to abort incomplete multipart uploads that are one day old, and fill the storage configuration in configs.imageregistry.operator.openshift.io/cluster.

wzheng1 · 2019-04-25T08:54:50Z

This command is invalid.

When UPI on AWS cluster is ready, s3 storage is automatically configured.

@wzheng1 this is only true if the cluster admin/installer provides an AWS account that has permission to create S3 buckets.

We should reference AWS docs on how to create an S3 bucket.

Whether this doc works? https://docs.aws.amazon.com/AmazonS3/latest/gsg/GetStartedWithS3.html

The AWS UPI doc says that you need the S3 permission to create a bucket, and the steps as written have you create a bucket to store your bootstrap ignition config.

wzheng1 · 2019-04-25T09:06:04Z

If you delete all s3 part on AWS with UPI, it will be generated automatically, admin doesn't need to input manually.

Admin may want to create a cluster with credentials that doesn't allow to create buckets. In this case the administrator should configure it manually.

wzheng1 · 2019-04-25T09:17:06Z

Another thing I think need to add is to pay attention whether the cluster has default storage class, since if it has, any pvc will be attached to it automatically, this doesn't adapt to image-registry since inconsistent accessMode. So user has to specify in pv which pvc should be claimed like below:
"claimRef": {
"namespace": "openshift-image-registry",
"name": "image-registry-storage"
},
@adambkaplan please help to review too.

adambkaplan · 2019-05-08T19:01:09Z

@wzheng1 this is only true if the cluster admin/installer provides an AWS account that has permission to create S3 buckets.

adambkaplan · 2019-05-08T19:01:50Z

We should reference AWS docs on how to create an S3 bucket.

adambkaplan · 2019-05-08T19:02:20Z

Add bucket: <bucket-name>

adambkaplan · 2019-05-08T19:03:00Z

oc get pods -n openshift-image-registry

adambkaplan · 2019-05-08T19:06:43Z

oc get clusteroperator image-registry

adambkaplan · 2019-05-08T19:07:51Z

oc get pod -n openshift-image-registry

bmcelvee · 2019-05-13T14:12:48Z

@openshift/team-documentation - please peer review

(I think the suggested PVs for bare metal and vSphere will need to change once we have storage updates, but that can come in a follow-up PR.)

kalexand-rh · 2019-05-13T17:38:34Z

an S3 bucket,

kalexand-rh · 2019-05-13T17:42:08Z

The AWS UPI doc says that you need the S3 permission to create a bucket, and the steps as written have you create a bucket to store your bootstrap ignition config.

kalexand-rh · 2019-05-13T17:44:02Z

@huffmanca, when you're back in the office, we need to talk about the install-level prereqs we need to state for storage.

kalexand-rh · 2019-05-13T17:44:31Z

I'd move "such as Azure File or NFS." info to the prereq.

Can you show the commands that you'd run for these two steps?

kalexand-rh · 2019-05-13T17:44:51Z

What am I looking for here?

$oc edit configs.imageregistry.operator.openshift.io
storage:
pvc:
claim:

If you leave the claim name to be blank, a pvc named image-registry-storage will be created automatically.

kalexand-rh · 2019-05-13T17:59:51Z

Can you change the registry storage after installation? Do they need to go here, or just in the installation assemblies?

Yes, you can, as long as you are admin : ) vsphere and baremetal UPI installation should configure storage after installation, as original installation will prompt storage not configured error.

kalexand-rh · 2019-05-13T18:00:36Z

Would you use Azure or NFS with vSphere? I'd still move this info to the prereqs and show the commands to do these first two steps.

kalexand-rh · 2019-05-13T18:01:23Z

This makes it look like your storage is still not configured. Is that right? If you wait and run the command again, should you see a different message?

bmcelvee · 2019-05-17T14:48:35Z

@adambkaplan @dmage - would either of you be able to provide the procedures for these two steps or point me to where I can find them? Thanks!

. To configure your registry to use storage, change the spec.storage.pvc in
the configs.imageregistry/cluster resource.

. Provide a suitable persistent volume.

adambkaplan

@bmcelvee the steps here don't really make sense to me. Configuring PVC storage is much simpler:

Cluster admin must set up Persistent Volume(s) that support ReadWriteMany access modes (ex: NFS) - prerequisite and out of scope.
Make sure the registry is not up - check status of the cluster operator or operator config:
$ oc get clusteroperator image-registry or $ oc get config.imageregistry.operator.openshift.io/cluster -o yaml
Edit the cluster operator config to set the storage to use PVC
Wait for the registry to come up (watch the clusteroperator - should report Available=true)

adambkaplan · 2019-05-17T16:05:49Z

Suggested change

* PV with `ReadWriteMany` access mode, such as Azure File or NFS.

* A provisioned Persistent Volume with `ReadWriteMany` access mode, such as Azure File or NFS.

You may also want out-link to upstream docs on PVs: https://v1-13.docs.kubernetes.io/docs/concepts/storage/persistent-volumes/

adambkaplan · 2019-05-17T16:09:01Z

@bmcelvee I'd consider this out of scope for this portion of the doc - the assumed prerequisite is that the cluster admin provisioned storage that can be satisfied via a PVC.

bmcelvee · 2019-05-17T17:47:24Z

I think we've reached a point where this content can be merged. If it requires additional content or changes, those items can be addressed in a follow-up PR.

bmcelvee added the branch/enterprise-4.1 label Apr 10, 2019

bmcelvee added this to the Future Release milestone Apr 10, 2019

openshift-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 10, 2019

dmage reviewed Apr 11, 2019

View reviewed changes

bmcelvee force-pushed the add-registry-storage-modules branch from 39145ae to 35146c6 Compare April 15, 2019 17:29

bmcelvee changed the base branch from enterprise-4.0 to enterprise-4.1 April 17, 2019 14:25

bmcelvee force-pushed the add-registry-storage-modules branch from 35146c6 to 0495a79 Compare April 24, 2019 15:26

openshift-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 24, 2019

wzheng1 reviewed Apr 25, 2019

View reviewed changes

Comment thread modules/registry-configuring-storage-baremetal.adoc Outdated

wzheng1 reviewed Apr 25, 2019

View reviewed changes

Comment thread modules/registry-configuring-storage-baremetal.adoc Outdated

wzheng1 reviewed Apr 25, 2019

View reviewed changes

Comment thread modules/registry-configuring-storage-vsphere.adoc Outdated

wzheng1 reviewed Apr 25, 2019

View reviewed changes

Comment thread modules/registry-configuring-storage-vsphere.adoc Outdated

bmcelvee mentioned this pull request May 6, 2019

osdocs-154 Document Registry Operator #14476

Merged

bmcelvee force-pushed the add-registry-storage-modules branch from 0495a79 to 5e2a627 Compare May 8, 2019 17:54

adambkaplan requested changes May 8, 2019

View reviewed changes

bmcelvee force-pushed the add-registry-storage-modules branch from 5e2a627 to fffc92e Compare May 13, 2019 14:10

bmcelvee added the peer-review-needed Signifies that the peer review team needs to review this PR label May 13, 2019

bmcelvee changed the title ~~[WIP] Add registry storage configuration modules~~ Add registry storage configuration modules May 13, 2019

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 13, 2019

kalexand-rh reviewed May 13, 2019

View reviewed changes

kalexand-rh added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels May 13, 2019

bmcelvee force-pushed the add-registry-storage-modules branch from fffc92e to 4d5cf25 Compare May 13, 2019 20:29

bmcelvee force-pushed the add-registry-storage-modules branch from 4d5cf25 to 04ce691 Compare May 14, 2019 13:54

bmcelvee commented May 17, 2019

View reviewed changes

adambkaplan requested changes May 17, 2019

View reviewed changes

Add registry storage configuration modules

749b501

bmcelvee force-pushed the add-registry-storage-modules branch from 04ce691 to 749b501 Compare May 17, 2019 17:42

bmcelvee merged commit 0c92649 into openshift:enterprise-4.1 May 17, 2019

vikram-redhat modified the milestones: Future Release, OCP 4.1 GA Jun 3, 2019

	* PV with `ReadWriteMany` access mode, such as Azure File or NFS.
	* A provisioned Persistent Volume with `ReadWriteMany` access mode, such as Azure File or NFS.

Conversation

bmcelvee commented Apr 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-docs-preview-bot commented Apr 10, 2019

Uh oh!

dmage Apr 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wzheng1 Apr 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wzheng1 commented Apr 25, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bmcelvee commented May 13, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adambkaplan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bmcelvee commented May 17, 2019

bmcelvee commented Apr 10, 2019 •

edited

Loading

dmage Apr 11, 2019 •

edited

Loading

wzheng1 Apr 25, 2019 •

edited

Loading