osdocs-154 Document Registry Operator by bmcelvee · Pull Request #14476 · openshift/openshift-docs

bmcelvee · 2019-04-16T20:10:23Z

https://jira.coreos.com/browse/OSDOCS-154

bmcelvee · 2019-05-01T15:32:36Z

@dmage PTAL, thanks! :)

dmage · 2019-05-02T09:48:53Z

configs.imageregistry.operator.openshift.io/cluster

dmage · 2019-05-02T09:51:49Z

It is implemented.

dmage · 2019-05-02T09:53:16Z

config.imageregistry.operator.openshift.io?

Should be configs.imageregistry.operator.openshift.io

dmage · 2019-05-02T09:54:47Z

This can't be changed by a user anymore. They should create config map in the openshift-config namespace and use AdditionalTrustedCA in the image.config.openshift.io resource.

Thanks, @dmage! I temporarily commented out the original config content, and put in the following:

"You can create a ConfigMap in the openshift-config namespace and use AdditionalTrustedCA in the image.config.openshift.io resource to contact external registries."

Does that make sense? I think it would also be helpful to provide an example.

@bmcelvee

"You can create a ConfigMap in the openshift-config namespace and use it name in AdditionalTrustedCA in the image.config.openshift.io resource to provide additional certificate authorities that should be trusted when contacting external registries."

Something like this?.. Maybe it should be a link for another document. For the registry the keys in this ConfigMap don't matter. But for runtime and builds, the config map should look like this:

apiVersion: v1 kind: ConfigMap metadata: name: my-registry-ca data: registry.example.com: | -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- registry-with-port.example.com..5000: | -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----

The key is the host name of a registry with the port for which this CA is to be trusted. Note that if the registry has the port, like registry-with-port.example.com:5000, : should be replaced with ...

@adambkaplan are there any additional requirements for this from builds?

@dmage @bmcelvee worth mentioning that the certIificates must be PEM-encoded (which is the norm). I would stick to the format needed by builds and runtimes in any example.

bmcelvee · 2019-05-02T18:42:57Z

@dmage - another question: Is there a default config.imageregistry.operator.openshift.io CRD?

@bmcelvee yes, the image registry operator (in managed state) always creates configs.imageregistry.operator.openshift.io/cluster when it doesn't exist.

bmcelvee · 2019-05-02T18:43:50Z

Thanks, @dmage! Just have a couple more questions on this one.

bmcelvee · 2019-05-03T18:56:33Z

@wzheng1 PTAL, thanks!

wzheng1 · 2019-05-06T08:04:38Z

It is better to highlight some configures are needed during installation for UPI on baremetal and vsphere, since there is no default storage configure for them, it will return: Unable to apply resources: storage backend not configured.
In this case, when try to describe clusteropeartor image-registry:
Status:
Conditions:
Last Transition Time: 2019-04-15T05:28:10Z
Message: The registry is ready
Reason: Ready
Status: True
Type: Available
Last Transition Time: 2019-04-16T05:42:07Z
Message: Unable to apply resources: storage backend not configured
Reason: Error
Status: True
Type: Progressing
Last Transition Time: 2019-04-16T05:42:07Z
Message: storage backend not configured
Reason: StorageNotConfigured
Status: True
Type: Failing

FYI https://github.com/openshift/installer/blob/master/docs/user/vsphere/install_upi.md#updating-image-registry-to-emptydir-storage-backend

Thanks, @wzheng1! I added the following note, and am still working on the registry storage PR to go in the "Installing" book - #14390.

"Storage is only automatically configured when you install on AWS."

bmcelvee · 2019-05-08T17:09:45Z

@openshift/team-documentation please peer review, thanks!

kalexand-rh · 2019-05-10T18:18:17Z

`image-registry` ?
Are these UI fields or parameters in the yaml definition? If they're in the yaml, they should be "configuration parameters."

kalexand-rh · 2019-05-10T18:18:56Z

We switched to `` instead of ** for parameters and values in 4.1.

kalexand-rh · 2019-05-10T18:20:26Z

s/operator/Operator
^ all places

Please double-check that all the future tense is necessary - present tense often is good enough.
The : should be outside the formatting.
Double-check that each entry starts with a capital letter and ends with a period.

kalexand-rh · 2019-05-10T18:22:43Z

Are these fields, or components, or states? It feels like the descriptions have different functions for different entries. I feel like some of them would benefit from having values or default values provided.

kalexand-rh · 2019-05-10T18:27:40Z

This paragraph sounds like it should be a procedure module.

kalexand-rh · 2019-05-10T18:33:30Z

I'd combine this instruction with the step.
Also, why am I patching it, and what am I patching it with?

kalexand-rh · 2019-05-10T18:34:32Z

maybe s/. It/, and it
registry,

kalexand-rh · 2019-05-10T18:36:16Z

I'd s/AWS/Amazon Web Services

Do you have an issue to add, or refer to, the image registry storage configuration modules when they exist?

kalexand-rh · 2019-05-10T18:39:06Z

"On initial startup" or "After the control plane deploys" ?

kalexand-rh · 2019-05-10T18:39:14Z

Like if you don't have storage set up?

bmcelvee · 2019-05-10T19:45:42Z

Going ahead and merging. Any additional updates can be made in follow-up PRs.

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

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

openshift-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 16, 2019

bmcelvee changed the title ~~osdocs-154 Document Registry Operator~~ [WIP] osdocs-154 Document Registry Operator Apr 16, 2019

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

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

bmcelvee force-pushed the osdocs-154-registry-operator branch from 3e3122c to 5901e4d Compare April 30, 2019 20:00

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 30, 2019

bmcelvee force-pushed the osdocs-154-registry-operator branch from 5901e4d to 2004380 Compare May 1, 2019 15:01

dmage reviewed May 2, 2019

View reviewed changes

bmcelvee force-pushed the osdocs-154-registry-operator branch from 2004380 to 9fd2ad8 Compare May 2, 2019 18:39

bmcelvee commented May 2, 2019

View reviewed changes

bmcelvee force-pushed the osdocs-154-registry-operator branch 4 times, most recently from 94c9aa7 to c59fc3b Compare May 3, 2019 18:52

wzheng1 reviewed May 6, 2019

View reviewed changes

bmcelvee force-pushed the osdocs-154-registry-operator branch from c59fc3b to 4d70646 Compare May 6, 2019 15:13

bmcelvee changed the title ~~[WIP] osdocs-154 Document Registry Operator~~ osdocs-154 Document Registry Operator May 8, 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 8, 2019

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

bmcelvee force-pushed the osdocs-154-registry-operator branch from 4d70646 to 48f2ba6 Compare May 10, 2019 18:10

kalexand-rh reviewed May 10, 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 10, 2019

osdocs-154 Document Registry Operator

d3a66cb

bmcelvee force-pushed the osdocs-154-registry-operator branch from 48f2ba6 to d3a66cb Compare May 10, 2019 19:20

bmcelvee merged commit f147cc6 into openshift:enterprise-4.1 May 10, 2019

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

Conversation

bmcelvee commented Apr 16, 2019

Uh oh!

bmcelvee commented May 1, 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!

bmcelvee commented May 2, 2019

Uh oh!

bmcelvee commented May 3, 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!

bmcelvee commented May 8, 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!

bmcelvee commented May 10, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants