diff --git a/Makefile b/Makefile index 0513b41c..5c9017cb 100644 --- a/Makefile +++ b/Makefile @@ -236,6 +236,9 @@ sync-minio-version: sync-sdks: @(./sync-docs.sh) +sync-operator-crd: + @(./sync-minio-operator-crd.sh) + # Can probably safely remove this at some point sync-deps: # C++ and Rust repos do not have any releases yet. diff --git a/README.md b/README.md index 90c7bb10..42aa5e36 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ MinIO uses [Sphinx](https://www.sphinx-doc.org/en/master/index.html) to generate - Any GNU/Linux Operating System, or macOS 12.3 or later. - python 3.10.x and python-pip - python3.10-venv -- sphinx 4.3.2 +- sphinx 6.2.1 - nodejs 14.5.0 or later - npm 16.19.1 or later - `git` or a git-compatible client @@ -69,6 +69,27 @@ Does the following: 1. Check that the `build/GITDIR/linux` folder exists 2. Copies the contents of `build/GITDIR/linux/html/*` to `docs-staging/staging/GITDIR/linux` +# Syncing Operator CRD Docs + +For importing the Operator CRD Docs specifically, you must have: + +- pandoc (latest stable) +- asciidoc (latest stable) + +In addition to all other prerequisites. + +Run + +``` +make sync-operator-crd +``` + +This downloads and converts the `tenant-crd.adoc` from the MinIO Operator github repository. +It converts it to XML, then to markdown. +Finally, it does some `sed` find/replace to tidy up the file for Sphinx ingest. + +You can run this when we have a new Operator release being documented, assuming there are changes to the CRD as part of that release. + # License This project is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/legalcode). See [CONTRIBUTING.md](https://github.com/minio/docs/tree/master/CONTRIBUTING.md) guide for more information on contributing to the MinIO Documentation project. diff --git a/source/_static/scss/includes/_misc.scss b/source/_static/scss/includes/_misc.scss index b410bc1e..19d8fe86 100644 --- a/source/_static/scss/includes/_misc.scss +++ b/source/_static/scss/includes/_misc.scss @@ -370,4 +370,14 @@ figcaption { font-size: small; font-weight: bold; } +} + + +// --------------------------------------- +// Fixing table issues from asciidoc -> md +// --------------------------------------- + +table thead tr.header { + background-color: lightgray; + box-shadow: none; } \ No newline at end of file diff --git a/source/includes/k8s/ext-tenant-crd.md b/source/includes/k8s/ext-tenant-crd.md new file mode 100644 index 00000000..9210876b --- /dev/null +++ b/source/includes/k8s/ext-tenant-crd.md @@ -0,0 +1,1603 @@ + + +# Operator CRD v2 Reference + +Package v2 - This page provides a quick automatically generated +reference for the MinIO Operator `Operator CRD v2 Reference` CRD. For more +complete documentation on the MinIO Operator CRD, see [MinIO Kubernetes +Documentation](https://min.io/docs/minio/kubernetes/upstream/index.html). + +The `Operator CRD v2 Reference` API was released with the v4.0.0 MinIO Operator. +The MinIO Operator automatically converts existing tenants using the +`/v1` API to `/v2`. + +- [Tenant](#tenant) + +## Bucket + +Bucket describes the default created buckets + +- [TenantSpec](#tenantspec) + +
Field | +Description | +
---|---|
|
++ |
|
++ |
|
++ |
Field | +Description | +
---|---|
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
Field | +Description | +
---|---|
|
+AutoCertEnabled registers whether we +know if the tenant has autocert enabled |
+
|
+Provides the output of the
+ |
+
Field | +Description | +
---|---|
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
Field | +Description | +
---|---|
|
+Optional |
+
|
+Optional |
+
Field | +Description | +
---|---|
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
Field | +Description | +
---|---|
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Required |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Specify the Security
+Context of MinIO KES pods. The Operator supports only the following
+pod security fields: |
+
|
+Optional |
+
Field | +Description | +
---|---|
|
+Required |
+
|
+Required |
+
Field | +Description | +
---|---|
|
++ |
|
++ |
|
++ |
Field | +Description | +
---|---|
|
+Optional |
+
|
+Required The number of
+MinIO server pods to deploy in the pool. The minimum value is
+ |
+
|
+Required |
+
|
+Required |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Specify the Security
+Context of containers in the pool. The Operator supports only the
+following container security fields: |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
Field | +Description | +
---|---|
|
++ |
|
++ |
|
+LegacySecurityContext stands for Legacy +SecurityContext. It represents that these pool was created before v4.2.3 +when we introduced the default securityContext as non-root, thus we +should keep running this Pool without a Security Context |
+
Field | +Description | +
---|---|
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
Field | +Description | +
---|---|
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
Field | +Description | +
---|---|
|
+
|
+
|
+
|
+
|
+Refer to Kubernetes API documentation
+for fields of |
+
|
++ |
|
+Required |
+
Field | +Description | +
---|---|
|
+List of Domains used by MinIO. This +will enable DNS style access to the object store where the bucket name +is inferred from a subdomain in the domain. |
+
|
+Domain used to expose the MinIO +Console, this will configure the redirect on MinIO when visiting from +the browser If Console is exposed via a subpath, the domain should +include it, i.e. https://console.domain.com:8123/subpath/ |
+
Field | +Description | +
---|---|
|
+Optional |
+
Field | +Description | +
---|---|
|
+Required |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Liveness Probe for container liveness. +Container will be restarted if the probe fails. |
+
|
+Readiness Probe for container +readiness. Container will be removed from service endpoints if the probe +fails. |
+
|
+Startup Probe allows to configure a max +grace period for a pod to start before getting traffic routed to +it. |
+
|
+S3 related features can be disabled or
+enabled such as |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
|
+Optional |
+
Field | +Description | +
---|---|
|
+Capacity the usage capacity of this +tenant in bytes. |
+
|
+Capacity the raw capacity of this +tenant in bytes. |
+
|
+Usage is how much data is managed by +MinIO in bytes. |
+
|
+Usage is the raw usage on disks in +bytes. |
+
|
+Tiers includes the usage of individual +tiers in the tenant |
+
Field | +Description | +
---|---|
|
+Name of the tier |
+
|
+type of the tier |
+
|
+TotalSize usage of the tier |
+