Skip to content

Commit

Permalink
Fields immutable (#2070)
Browse files Browse the repository at this point in the history
  • Loading branch information
pjuarezd authored Apr 14, 2024
1 parent be17c70 commit cf7fe17
Show file tree
Hide file tree
Showing 12 changed files with 745 additions and 284 deletions.
43 changes: 29 additions & 14 deletions docs/job_crd.adoc
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-02-09T21-25-16Z]
:kes-image: https://hub.docker.com/r/minio/kes/tags[minio/kes:2024-01-11T13-09-29Z]
: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]


[id="{anchor_prefix}-job-min-io-v1alpha1"]
Expand All @@ -32,8 +32,10 @@ CommandSpec (`spec`) defines the configuration of a MinioClient Command.
| Field | Description

|*`op`* __string__
|*Required* +
Operation is the MinioClient Action
|*Required* +


Operation is the MinioClient Action

|*`name`* __string__
|Name is the Command Name, optional, required if want to reference it with `DependsOn`
Expand Down Expand Up @@ -116,8 +118,10 @@ MinIOJob is a top-level type. A client is created for it


|*`spec`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-job-min-io-v1alpha1-miniojobspec[$$MinIOJobSpec$$]__
|*Required* +
The root field for the MinIOJob object.
|*Required* +


The root field for the MinIOJob object.

|===

Expand All @@ -139,22 +143,33 @@ MinIOJobSpec (`spec`) defines the configuration of a MinIOJob object. +
| Field | Description

|*`serviceAccountName`* __string__
|*Required* +
Service Account name for the jobs to run
|*Required* +


Service Account name for the jobs to run

|*`tenant`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-job-min-io-v1alpha1-tenantref[$$TenantRef$$]__
|*Required* +
TenantRef Reference for minio Tenant to eun the jobs against
|*Required* +


TenantRef Reference for minio Tenant to eun the jobs against

|*`execution`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-job-min-io-v1alpha1-execution[$$Execution$$]__
|Execution order of the jobs, either `parallel` or `sequential`. Defaults to `parallel` if not provided.
|Execution order of the jobs, either `parallel` or `sequential`.
Defaults to `parallel` if not provided.

|*`failureStrategy`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-job-min-io-v1alpha1-failurestrategy[$$FailureStrategy$$]__
|FailureStrategy is the forward plan in case of the failure of one or more MinioJob pods Either `stopOnFailure` or `continueOnFailure`, defaults to `continueOnFailure`.
|FailureStrategy is the forward plan in case of the failure of one or more MinioJob pods
Either `stopOnFailure` or `continueOnFailure`, defaults to `continueOnFailure`.

|*`commands`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-job-min-io-v1alpha1-commandspec[$$CommandSpec$$] array__
|*Required* +
Commands List of MinioClient commands
|*Required* +


Commands List of MinioClient commands

|*`mcImage`* __string__
|mc job image

|===

Expand Down
12 changes: 8 additions & 4 deletions docs/policybinding_crd.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,10 @@ PolicyBinding is a https://kubernetes.io/docs/concepts/overview/working-with-obj


|*`spec`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-policybindingspec[$$PolicyBindingSpec$$]__
|*Required* +
The root field for the MinIO PolicyBinding object.
|*Required* +


The root field for the MinIO PolicyBinding object.

|===

Expand All @@ -84,8 +86,10 @@ PolicyBindingSpec (`spec`) defines the configuration of a MinIO PolicyBinding ob
| Field | Description

|*`application`* __xref:{anchor_prefix}-github-com-minio-operator-pkg-apis-sts-min-io-v1alpha1-application[$$Application$$]__
|*Required* +
The Application Property identifies the namespace and service account that will be authorized
|*Required* +


The Application Property identifies the namespace and service account that will be authorized

|*`policies`* __string array__
|*Required* +
Expand Down
Loading

0 comments on commit cf7fe17

Please sign in to comment.