Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify image config doc #570

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions config/v1/0000_10_config-operator_01_image.crd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ spec:
description: Image governs policies related to imagestream imports and runtime
configuration for external registries. It allows cluster admins to configure
which registries OpenShift is allowed to import images from, extra CA trust
bundles for external registries, and policies to blacklist/whitelist registry
hostnames. When exposing OpenShift's image registry to the public, this also
lets cluster admins specify the external hostname.
bundles for external registries, and policies to block or allow registry hostnames.
When exposing OpenShift's image registry to the public, this also lets cluster
admins specify the external hostname.
type: object
required:
- spec
Expand Down Expand Up @@ -101,16 +101,16 @@ spec:
type: object
properties:
allowedRegistries:
description: "allowedRegistries are whitelisted for image pull/push.
All other registries are blocked. \n Only one of BlockedRegistries
or AllowedRegistries may be set."
description: "allowedRegistries are the only registries permitted
for image pull and push actions. All other registries are denied.
\n Only one of BlockedRegistries or AllowedRegistries may be set."
type: array
items:
type: string
blockedRegistries:
description: "blockedRegistries are blacklisted from image pull/push.
All other registries are allowed. \n Only one of BlockedRegistries
or AllowedRegistries may be set."
description: "blockedRegistries cannot be used for image pull and
push actions. All other registries are permitted. \n Only one
of BlockedRegistries or AllowedRegistries may be set."
type: array
items:
type: string
Expand Down
6 changes: 3 additions & 3 deletions config/v1/types_image.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
// Image governs policies related to imagestream imports and runtime configuration
// for external registries. It allows cluster admins to configure which registries
// OpenShift is allowed to import images from, extra CA trust bundles for external
// registries, and policies to blacklist/whitelist registry hostnames.
// registries, and policies to block or allow registry hostnames.
// When exposing OpenShift's image registry to the public, this also lets cluster
// admins specify the external hostname.
type Image struct {
Expand Down Expand Up @@ -102,12 +102,12 @@ type RegistrySources struct {
// insecureRegistries are registries which do not have a valid TLS certificates or only support HTTP connections.
// +optional
InsecureRegistries []string `json:"insecureRegistries,omitempty"`
// blockedRegistries are blacklisted from image pull/push. All other registries are allowed.
// blockedRegistries cannot be used for image pull and push actions. All other registries are permitted.
//
// Only one of BlockedRegistries or AllowedRegistries may be set.
// +optional
BlockedRegistries []string `json:"blockedRegistries,omitempty"`
// allowedRegistries are whitelisted for image pull/push. All other registries are blocked.
// allowedRegistries are the only registries permitted for image pull and push actions. All other registries are denied.
//
// Only one of BlockedRegistries or AllowedRegistries may be set.
// +optional
Expand Down
6 changes: 3 additions & 3 deletions config/v1/zz_generated.swagger_doc_generated.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.