API Reference
Packages
objectstorage.k8s.io/v1alpha1
AuthenticationType
Underlying type: string
Appears in:
| Field | Description |
|---|---|
Key | |
IAM |
Bucket
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
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 | ||
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 | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BucketSpec | |||
status BucketStatus |
BucketAccess
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
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 | ||
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 | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BucketAccessSpec | |||
status BucketAccessStatus |
BucketAccessClass
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
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 | ||
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 | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
driverName string | DriverName is the name of driver associated with this BucketAccess | ||
authenticationType AuthenticationType | AuthenticationType denotes the style of authentication It can be one of Key - access, secret tokens based authentication IAM - implicit authentication of pods to the OSP based on service account mappings | ||
parameters object (keys:string, values:string) | Parameters is an opaque map for passing in configuration to a driver for granting access to a bucket |
BucketAccessSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
bucketClaimName string | BucketClaimName is the name of the BucketClaim. | ||
protocol Protocol | Protocol is the name of the Protocol that this access credential is supposed to support If left empty, it will choose the protocol supported by the bucket. If the bucket supports multiple protocols, the end protocol is determined by the driver. | ||
bucketAccessClassName string | BucketAccessClassName is the name of the BucketAccessClass | ||
credentialsSecretName string | CredentialsSecretName is the name of the secret that COSI should populate with the credentials. If a secret by this name already exists, then it is assumed that credentials have already been generated. It is not overridden. This secret is deleted when the BucketAccess is delted. | ||
serviceAccountName string | ServiceAccountName is the name of the serviceAccount that COSI will map to the OSP service account when IAM styled authentication is specified |
BucketAccessStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
accountID string | AccountID is the unique ID for the account in the OSP. It will be populated by the COSI sidecar once access has been successfully granted. | ||
accessGranted boolean | AccessGranted indicates the successful grant of privileges to access the bucket |
BucketClaim
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
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 | ||
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 | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BucketClaimSpec | |||
status BucketClaimStatus |
BucketClaimSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
bucketClassName string | Name of the BucketClass | ||
protocols Protocol array | Protocols are the set of data API this bucket is required to support. The possible values for protocol are: - S3: Indicates Amazon S3 protocol - Azure: Indicates Microsoft Azure BlobStore protocol - GCS: Indicates Google Cloud Storage protocol | ||
existingBucketName string | Name of a bucket object that was manually created to import a bucket created outside of COSI If unspecified, then a new Bucket will be dynamically provisioned |
BucketClaimStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
bucketReady boolean | BucketReady indicates that the bucket is ready for consumpotion by workloads | ||
bucketName string | BucketName is the name of the provisioned Bucket in response to this BucketClaim. It is generated and set by the COSI controller before making the creation request to the OSP backend. |
BucketClass
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
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 | ||
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 | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
driverName string | DriverName is the name of driver associated with this bucket | ||
deletionPolicy DeletionPolicy | DeletionPolicy is used to specify how COSI should handle deletion of this bucket. There are 2 possible values: - Retain: Indicates that the bucket should not be deleted from the OSP - Delete: Indicates that the bucket should be deleted from the OSP once all the workloads accessing this bucket are done | Retain | |
parameters object (keys:string, values:string) | Parameters is an opaque map for passing in configuration to a driver for creating the bucket |
BucketSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
driverName string | DriverName is the name of driver associated with this bucket | ||
bucketClassName string | Name of the BucketClass specified in the BucketRequest | ||
bucketClaim ObjectReference | Name of the BucketClaim that resulted in the creation of this Bucket In case the Bucket object was created manually, then this should refer to the BucketClaim with which this Bucket should be bound | ||
protocols Protocol array | Protocols are the set of data APIs this bucket is expected to support. The possible values for protocol are: - S3: Indicates Amazon S3 protocol - Azure: Indicates Microsoft Azure BlobStore protocol - GCS: Indicates Google Cloud Storage protocol | ||
parameters object (keys:string, values:string) | |||
deletionPolicy DeletionPolicy | DeletionPolicy is used to specify how COSI should handle deletion of this bucket. There are 2 possible values: - Retain: Indicates that the bucket should not be deleted from the OSP (default) - Delete: Indicates that the bucket should be deleted from the OSP once all the workloads accessing this bucket are done | Retain | |
existingBucketID string | ExistingBucketID is the unique id of the bucket in the OSP. This field should be used to specify a bucket that has been created outside of COSI. This field will be empty when the Bucket is dynamically provisioned by COSI. |
BucketStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
bucketReady boolean | BucketReady is a boolean condition to reflect the successful creation of a bucket. | ||
bucketID string | BucketID is the unique id of the bucket in the OSP. This field will be populated by COSI. |
DeletionPolicy
Underlying type: string
Appears in:
| Field | Description |
|---|---|
Retain | |
Delete |
Protocol
Underlying type: string
Appears in:
| Field | Description |
|---|---|
S3 | |
Azure | |
GCP |