v1alpha1

type SharedConfigMap ¶

type SharedConfigMap struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// spec is the specification of the desired shared configmap
	// +kubebuilder:validation:Required
	Spec SharedConfigMapSpec `json:"spec,omitempty"`

	// status is the observed status of the shared configmap
	Status SharedConfigMapStatus `json:"status,omitempty"`
}

SharedConfigMap allows a ConfigMap to be shared across namespaces. Pods can mount the shared ConfigMap by adding a CSI volume to the pod specification using the "csi.sharedresource.openshift.io" CSI driver and a reference to the SharedConfigMap in the volume attributes:

spec:

volumes:
- name: shared-configmap
  csi:
    driver: csi.sharedresource.openshift.io
    volumeAttributes:
      sharedConfigMap: my-share

For the mount to be successful, the pod's service account must be granted permission to 'use' the named SharedConfigMap object within its namespace with an appropriate Role and RoleBinding. For compactness, here are example `oc` invocations for creating such Role and RoleBinding objects.

`oc create role shared-resource-my-share --verb=use --resource=sharedconfigmaps.sharedresource.openshift.io --resource-name=my-share`
`oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default`

Shared resource objects, in this case ConfigMaps, have default permissions of list, get, and watch for system authenticated users.

Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support. +k8s:openapi-gen=true +openshift:compatibility-gen:level=4 +kubebuilder:subresource:status

func (in *SharedConfigMap) DeepCopy() *SharedConfigMap

func (in *SharedConfigMap) DeepCopyInto(out *SharedConfigMap)

func (in *SharedConfigMap) DeepCopyObject() runtime.Object

func (SharedConfigMap) SwaggerDoc() map[string]string

type SharedConfigMapList ¶

type SharedConfigMapList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []SharedConfigMap `json:"items"`
}

SharedConfigMapList contains a list of SharedConfigMap objects.

Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support. +openshift:compatibility-gen:level=4

func (in *SharedConfigMapList) DeepCopy() *SharedConfigMapList

func (in *SharedConfigMapList) DeepCopyInto(out *SharedConfigMapList)

func (in *SharedConfigMapList) DeepCopyObject() runtime.Object

func (SharedConfigMapList) SwaggerDoc() map[string]string

type SharedConfigMapReference ¶

type SharedConfigMapReference struct {
	// name represents the name of the ConfigMap that is being referenced.
	// +kubebuilder:validation:Required
	Name string `json:"name"`
	// namespace represents the namespace where the referenced ConfigMap is located.
	// +kubebuilder:validation:Required
	Namespace string `json:"namespace"`
}

SharedConfigMapReference contains information about which ConfigMap to share

func (in *SharedConfigMapReference) DeepCopy() *SharedConfigMapReference

func (in *SharedConfigMapReference) DeepCopyInto(out *SharedConfigMapReference)

func (SharedConfigMapReference) SwaggerDoc() map[string]string

type SharedConfigMapSpec ¶

type SharedConfigMapSpec struct {
	//configMapRef is a reference to the ConfigMap to share
	// +kubebuilder:validation:Required
	ConfigMapRef SharedConfigMapReference `json:"configMapRef"`
	// description is a user readable explanation of what the backing resource provides.
	Description string `json:"description,omitempty"`
}

SharedConfigMapSpec defines the desired state of a SharedConfigMap +k8s:openapi-gen=true

func (in *SharedConfigMapSpec) DeepCopy() *SharedConfigMapSpec

func (in *SharedConfigMapSpec) DeepCopyInto(out *SharedConfigMapSpec)

func (SharedConfigMapSpec) SwaggerDoc() map[string]string

type SharedConfigMapStatus ¶

type SharedConfigMapStatus struct {
	// conditions represents any observations made on this particular shared resource by the underlying CSI driver or Share controller.
	// +patchMergeKey=type
	// +patchStrategy=merge
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

SharedSecretStatus contains the observed status of the shared resource

func (in *SharedConfigMapStatus) DeepCopy() *SharedConfigMapStatus

func (in *SharedConfigMapStatus) DeepCopyInto(out *SharedConfigMapStatus)

func (SharedConfigMapStatus) SwaggerDoc() map[string]string

type SharedSecret ¶

type SharedSecret struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// spec is the specification of the desired shared secret
	// +kubebuilder:validation:Required
	Spec SharedSecretSpec `json:"spec,omitempty"`

	// status is the observed status of the shared secret
	Status SharedSecretStatus `json:"status,omitempty"`
}

SharedSecret allows a Secret to be shared across namespaces. Pods can mount the shared Secret by adding a CSI volume to the pod specification using the "csi.sharedresource.openshift.io" CSI driver and a reference to the SharedSecret in the volume attributes:

spec:

volumes:
- name: shared-secret
  csi:
    driver: csi.sharedresource.openshift.io
    volumeAttributes:
      sharedSecret: my-share

For the mount to be successful, the pod's service account must be granted permission to 'use' the named SharedSecret object within its namespace with an appropriate Role and RoleBinding. For compactness, here are example `oc` invocations for creating such Role and RoleBinding objects.

`oc create role shared-resource-my-share --verb=use --resource=sharedsecrets.sharedresource.openshift.io --resource-name=my-share`
`oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default`

Shared resource objects, in this case Secrets, have default permissions of list, get, and watch for system authenticated users.

Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support. +openshift:compatibility-gen:level=4 +kubebuilder:subresource:status

func (in *SharedSecret) DeepCopy() *SharedSecret

func (in *SharedSecret) DeepCopyInto(out *SharedSecret)

func (in *SharedSecret) DeepCopyObject() runtime.Object

func (SharedSecret) SwaggerDoc() map[string]string

type SharedSecretList ¶

type SharedSecretList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []SharedSecret `json:"items"`
}

SharedSecretList contains a list of SharedSecret objects.

Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support. +openshift:compatibility-gen:level=4

func (in *SharedSecretList) DeepCopy() *SharedSecretList

func (in *SharedSecretList) DeepCopyInto(out *SharedSecretList)

func (in *SharedSecretList) DeepCopyObject() runtime.Object

func (SharedSecretList) SwaggerDoc() map[string]string

type SharedSecretReference ¶

type SharedSecretReference struct {
	// name represents the name of the Secret that is being referenced.
	// +kubebuilder:validation:Required
	Name string `json:"name"`
	// namespace represents the namespace where the referenced Secret is located.
	// +kubebuilder:validation:Required
	Namespace string `json:"namespace"`
}

SharedSecretReference contains information about which Secret to share

func (in *SharedSecretReference) DeepCopy() *SharedSecretReference

func (in *SharedSecretReference) DeepCopyInto(out *SharedSecretReference)

func (SharedSecretReference) SwaggerDoc() map[string]string

type SharedSecretSpec ¶

type SharedSecretSpec struct {
	// secretRef is a reference to the Secret to share
	// +kubebuilder:validation:Required
	SecretRef SharedSecretReference `json:"secretRef"`
	// description is a user readable explanation of what the backing resource provides.
	Description string `json:"description,omitempty"`
}

SharedSecretSpec defines the desired state of a SharedSecret +k8s:openapi-gen=true

func (in *SharedSecretSpec) DeepCopy() *SharedSecretSpec

func (in *SharedSecretSpec) DeepCopyInto(out *SharedSecretSpec)

func (SharedSecretSpec) SwaggerDoc() map[string]string

type SharedSecretStatus ¶

type SharedSecretStatus struct {
	// conditions represents any observations made on this particular shared resource by the underlying CSI driver or Share controller.
	// +patchMergeKey=type
	// +patchStrategy=merge
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

SharedSecretStatus contains the observed status of the shared resource

func (in *SharedSecretStatus) DeepCopy() *SharedSecretStatus

func (in *SharedSecretStatus) DeepCopyInto(out *SharedSecretStatus)

func (SharedSecretStatus) SwaggerDoc() map[string]string