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

Update generated code #2174

Merged
merged 2 commits into from
Jun 22, 2024
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
65 changes: 63 additions & 2 deletions docs/job_crd.adoc
ramondeklein marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
[id="{p}-api-reference"]
== API Reference

:minio-image: https://hub.docker.com/r/minio/minio/tags[minio/minio:RELEASE.2024-03-15T01-07-19Z]
:kes-image: https://hub.docker.com/r/minio/kes/tags[minio/kes:2024-03-13T17-52-13Z]
:minio-image: https://hub.docker.com/r/minio/minio/tags[minio/minio:RELEASE.2024-05-01T01-11-10Z]
:kes-image: https://hub.docker.com/r/minio/kes/tags[minio/kes:2024-04-12T13-50-00Z]
pjuarezd marked this conversation as resolved.
Show resolved Hide resolved


[id="{anchor_prefix}-job-min-io-v1alpha1"]
Expand Down Expand Up @@ -43,9 +43,37 @@ Operation is the MinioClient Action
|*`args`* __object (keys:string, values:string)__
|Args Arguments to pass to the action

|*`command`* __string array__
|Command Execute All User-Defined Commands

|*`dependsOn`* __string array__
|DependsOn List of named `command` in this MinioJob that have to be scheduled and executed before this command runs

|*`resources`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[$$ResourceRequirements$$]__
|Compute Resources required by this container.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

|*`envFrom`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#envfromsource-v1-core[$$EnvFromSource$$] array__
|List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.

|*`env`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#envvar-v1-core[$$EnvVar$$] array__
|List of environment variables to set in the container.
Cannot be updated.

|*`volumeMounts`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#volumemount-v1-core[$$VolumeMount$$] array__
|Pod volumes to mount into the container's filesystem.
Cannot be updated.

|*`volumes`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#volume-v1-core[$$Volume$$] array__
|List of volumes that can be mounted by containers belonging to the pod.
More info: https://kubernetes.io/docs/concepts/storage/volumes

|===


Expand Down Expand Up @@ -171,6 +199,39 @@ Commands List of MinioClient commands
|*`mcImage`* __string__
|mc job image

|*`securityContext`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#podsecuritycontext-v1-core[$$PodSecurityContext$$]__
|*Optional* +


Specify the https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[Security Context] of pods in the pool. The Operator supports only the following pod security fields: +


* `fsGroup` +


* `fsGroupChangePolicy` +


* `runAsGroup` +


* `runAsNonRoot` +


* `runAsUser` +

|*`containerSecurityContext`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#securitycontext-v1-core[$$SecurityContext$$]__
|Specify the https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[Security Context] of containers in the pool. The Operator supports only the following container security fields: +


* `runAsGroup` +


* `runAsNonRoot` +


* `runAsUser` +

|===


Expand Down
57 changes: 46 additions & 11 deletions docs/policybinding_crd.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
:kes-image: https://hub.docker.com/r/minio/kes/tags[minio/kes:2024-04-12T13-50-00Z]


[id="{anchor_prefix}-sts-min-io-v1alpha1"]
[id="{anchor_prefix}-sts-min-io-v1beta1"]
=== sts.min.io/v1beta1

Package v1beta1 - The following parameters are specific to the `sts.min.io/v1beta1` MinIO Policy Binding CRD API
Expand All @@ -17,16 +17,20 @@ Using Kubernetes ServiceAccount JSON Web Tokens the binding allow a ServiceAccou
For more complete documentation on this object, see the https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#minio-operator-yaml-reference[MinIO Kubernetes Documentation].
PolicyBinding is added as part of the MinIO Operator v5.0.0. +

.Resource Types
- xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybinding[$$PolicyBinding$$]
- xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybindinglist[$$PolicyBindingList$$]


[id="{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-application"]

[id="{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-application"]
==== Application

Application defines the `Namespace` and `ServiceAccount` to authorize the usage of the policies listed

.Appears In:
****
- xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-policybindingspec[$$PolicyBindingSpec$$]
- xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybindingspec[$$PolicyBindingSpec$$]
****

[cols="25a,75a", options="header"]
Expand All @@ -42,25 +46,31 @@ Application defines the `Namespace` and `ServiceAccount` to authorize the usage
|===


[id="{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-policybinding"]
[id="{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybinding"]
==== PolicyBinding

PolicyBinding is a https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/[Kubernetes object] describing a MinIO PolicyBinding.

.Appears In:
****
- xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-policybindinglist[$$PolicyBindingList$$]
- xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybindinglist[$$PolicyBindingList$$]
****

[cols="25a,75a", options="header"]
|===
| Field | Description

|*`apiVersion`* __string__
|`sts.min.io/v1beta1`

|*`kind`* __string__
|`PolicyBinding`

|*`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta[$$ObjectMeta$$]__
|Refer to Kubernetes API documentation for fields of `metadata`.


|*`spec`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-policybindingspec[$$PolicyBindingSpec$$]__
|*`spec`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybindingspec[$$PolicyBindingSpec$$]__
|*Required* +


Expand All @@ -69,23 +79,48 @@ The root field for the MinIO PolicyBinding object.
|===


[id="{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybindinglist"]
==== PolicyBindingList

PolicyBindingList is a list of PolicyBinding resources



[cols="25a,75a", options="header"]
|===
| Field | Description

|*`apiVersion`* __string__
|`sts.min.io/v1beta1`

|*`kind`* __string__
|`PolicyBindingList`

|*`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#listmeta-v1-meta[$$ListMeta$$]__
|Refer to Kubernetes API documentation for fields of `metadata`.


|*`items`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybinding[$$PolicyBinding$$] array__
|

|===


[id="{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-policybindingspec"]
[id="{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybindingspec"]
==== PolicyBindingSpec

PolicyBindingSpec (`spec`) defines the configuration of a MinIO PolicyBinding object. +

.Appears In:
****
- xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-policybinding[$$PolicyBinding$$]
- xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybinding[$$PolicyBinding$$]
****

[cols="25a,75a", options="header"]
|===
| Field | Description

|*`application`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-application[$$Application$$]__
|*`application`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-application[$$Application$$]__
|*Required* +


Expand All @@ -99,14 +134,14 @@ The Application Property identifies the namespace and service account that will



[id="{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-policybindingusage"]
[id="{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybindingusage"]
==== PolicyBindingUsage

PolicyBindingUsage are metrics regarding the usage of the policyBinding

.Appears In:
****
- xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-policybindingstatus[$$PolicyBindingStatus$$]
- xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1beta1-policybindingstatus[$$PolicyBindingStatus$$]
****

[cols="25a,75a", options="header"]
Expand Down
6 changes: 2 additions & 4 deletions docs/tenant_crd.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -364,13 +364,13 @@ Specify an object containing the following fields: +
|*Optional* +


Specify the GCP default credentials to be used for KES to authenticate to GCP key store
Specify the GCP default credentials to be used for KES to authenticate to GCP key store

|*`gcpWorkloadIdentityPool`* __string__
|*Optional* +


Specify the name of the workload identity pool (This is required for generating service account token)
Specify the name of the workload identity pool (This is required for generating service account token)

|*`annotations`* __object (keys:string, values:string)__
|*Optional* +
Expand Down Expand Up @@ -531,8 +531,6 @@ See the https://min.io/docs/minio/kubernetes/upstream/operations/install-deploy-

|*`name`* __string__
|*Required*


Specify the name of the pool. The Operator automatically generates the pool name if this field is omitted.

|*`servers`* __integer__
Expand Down
47 changes: 46 additions & 1 deletion pkg/apis/job.min.io/v1alpha1/zz_generated.deepcopy.go

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

2 changes: 1 addition & 1 deletion pkg/apis/minio.min.io/v2/zz_generated.deepcopy.go

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

2 changes: 1 addition & 1 deletion pkg/apis/sts.min.io/v1alpha1/zz_generated.deepcopy.go

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

2 changes: 1 addition & 1 deletion pkg/apis/sts.min.io/v1beta1/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
// +k8s:deepcopy-gen=package,register
// go:generate controller-gen crd:trivialVersions=true paths=. output:dir=.

// Package v1beta1 - The following parameters are specific to the `sts.min.io/vv1beta1` MinIO Policy Binding CRD API
// Package v1beta1 - The following parameters are specific to the `sts.min.io/v1beta1` MinIO Policy Binding CRD API
// PolicyBinding is an Authorization mechanism managed by the Minio Operator.
// Using Kubernetes ServiceAccount JSON Web Tokens the binding allow a ServiceAccount to assume temporary IAM credentials.
// For more complete documentation on this object, see the https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#minio-operator-yaml-reference[MinIO Kubernetes Documentation].
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/sts.min.io/v1beta1/zz_generated.deepcopy.go

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

2 changes: 1 addition & 1 deletion pkg/client/applyconfiguration/internal/internal.go

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

Loading
Loading