×
Description

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.

Type

object

Specification

Property Type Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec is the specification of the desired shared configmap

status

object

status is the observed status of the shared configmap

.spec

Description

spec is the specification of the desired shared configmap

Type

object

Required
  • configMapRef

Property Type Description

configMapRef

object

configMapRef is a reference to the ConfigMap to share

description

string

description is a user readable explanation of what the backing resource provides.

.spec.configMapRef

Description

configMapRef is a reference to the ConfigMap to share

Type

object

Required
  • name

  • namespace

Property Type Description

name

string

name represents the name of the ConfigMap that is being referenced.

namespace

string

namespace represents the namespace where the referenced ConfigMap is located.

.status

Description

status is the observed status of the shared configmap

Type

object

Property Type Description

conditions

array

conditions represents any observations made on this particular shared resource by the underlying CSI driver or Share controller.

conditions[]

object

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

.status.conditions

Description

conditions represents any observations made on this particular shared resource by the underlying CSI driver or Share controller.

Type

array

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Type

object

Required
  • lastTransitionTime

  • message

  • reason

  • status

  • type

Property Type Description

lastTransitionTime

string

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message

string

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration

integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason

string

reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status

string

status of the condition, one of True, False, Unknown.

type

string

type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

API endpoints

The following API endpoints are available:

  • /apis/sharedresource.openshift.io/v1alpha1/sharedconfigmaps

    • DELETE: delete collection of SharedConfigMap

    • GET: list objects of kind SharedConfigMap

    • POST: create a SharedConfigMap

  • /apis/sharedresource.openshift.io/v1alpha1/sharedconfigmaps/{name}

    • DELETE: delete a SharedConfigMap

    • GET: read the specified SharedConfigMap

    • PATCH: partially update the specified SharedConfigMap

    • PUT: replace the specified SharedConfigMap

  • /apis/sharedresource.openshift.io/v1alpha1/sharedconfigmaps/{name}/status

    • GET: read status of the specified SharedConfigMap

    • PATCH: partially update status of the specified SharedConfigMap

    • PUT: replace status of the specified SharedConfigMap

/apis/sharedresource.openshift.io/v1alpha1/sharedconfigmaps

HTTP method

DELETE

Description

delete collection of SharedConfigMap

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list objects of kind SharedConfigMap

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

SharedConfigMapList schema

401 - Unauthorized

Empty

HTTP method

POST

Description

create a SharedConfigMap

Table 3. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 4. Body parameters
Parameter Type Description

body

SharedConfigMap schema

Table 5. HTTP responses
HTTP code Reponse body

200 - OK

SharedConfigMap schema

201 - Created

SharedConfigMap schema

202 - Accepted

SharedConfigMap schema

401 - Unauthorized

Empty

/apis/sharedresource.openshift.io/v1alpha1/sharedconfigmaps/{name}

Table 6. Global path parameters
Parameter Type Description

name

string

name of the SharedConfigMap

HTTP method

DELETE

Description

delete a SharedConfigMap

Table 7. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 8. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified SharedConfigMap

Table 9. HTTP responses
HTTP code Reponse body

200 - OK

SharedConfigMap schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified SharedConfigMap

Table 10. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 11. HTTP responses
HTTP code Reponse body

200 - OK

SharedConfigMap schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified SharedConfigMap

Table 12. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 13. Body parameters
Parameter Type Description

body

SharedConfigMap schema

Table 14. HTTP responses
HTTP code Reponse body

200 - OK

SharedConfigMap schema

201 - Created

SharedConfigMap schema

401 - Unauthorized

Empty

/apis/sharedresource.openshift.io/v1alpha1/sharedconfigmaps/{name}/status

Table 15. Global path parameters
Parameter Type Description

name

string

name of the SharedConfigMap

HTTP method

GET

Description

read status of the specified SharedConfigMap

Table 16. HTTP responses
HTTP code Reponse body

200 - OK

SharedConfigMap schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update status of the specified SharedConfigMap

Table 17. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18. HTTP responses
HTTP code Reponse body

200 - OK

SharedConfigMap schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace status of the specified SharedConfigMap

Table 19. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 20. Body parameters
Parameter Type Description

body

SharedConfigMap schema

Table 21. HTTP responses
HTTP code Reponse body

200 - OK

SharedConfigMap schema

201 - Created

SharedConfigMap schema

401 - Unauthorized

Empty