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.

Sign up for GitHub

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

Jump to bottom

Update docs for fields allowed at root of the CRD schema #9973

Merged
merged 1 commit into from
Aug 21, 2018
Merged

Update docs for fields allowed at root of the CRD schema #9973

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 24 additions & 2 deletions ...ocs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,8 +447,9 @@ The column's `format` controls the style used when `kubectl` prints the value.

### Subresources

{{< feature-state state="beta" for_kubernetes_version="1.11" >}}

Custom resources support `/status` and `/scale` subresources.
This feature is __beta__ in v1.11 and enabled by default.

You can disable this feature using the `CustomResourceSubresources` feature gate on
the [kube-apiserver](/docs/admin/kube-apiserver):
Expand All @@ -469,7 +470,28 @@ When the status subresource is enabled, the `/status` subresource for the custom
- `PUT` requests to the `/status` subresource only validate the status stanza of the custom resource.
- `PUT`/`POST`/`PATCH` requests to the custom resource ignore changes to the status stanza.
- Any changes to the spec stanza increments the value at `.metadata.generation`.
- `properties`, `required` and `description` are the only constructs allowed in the root of the CRD OpenAPI validation schema.
- Only the following constructs are allowed at the root of the CRD OpenAPI validation schema:

- Description
- Example
- ExclusiveMaximum
- ExclusiveMinimum
- ExternalDocs
- Format
- Items
- Maximum
- MaxItems
- MaxLength
- Minimum
- MinItems
- MinLength
- MultipleOf
- Pattern
- Properties
- Required
- Title
- Type
- UniqueItems

#### Scale subresource

Expand Down