added overlay-schema to readme.md #93
Conversation
Signed-off-by: swastik959 <Sswastik959@gmail.com>
k8s-ci-robot
added
kind/documentation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: swastik959 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
size/S
|
@alexzielenski please review this pr |
Signed-off-by: swastik959 <Sswastik959@gmail.com>
|
@apelisse please have a look now |
| @@ -76,6 +76,15 @@ If the version is not recognized, `kubectl-validate` will attempt to look up | |||
| the schemas for the selected version in the official upstream Kubernetes repository | |||
| on GitHub. | |||
|
|
|||
| ## overlay-schemas | |||
There was a problem hiding this comment.
Turn this into a title rather than a slug?
| kubectl-validate --overlay-schemas <patch_file> | ||
| ``` | ||
|
|
||
|
|
| kubectl-validate --overlay-schemas <patch_file> | ||
| ``` | ||
|
|
||
|
|
| @@ -186,6 +195,7 @@ jobs: | |||
| run: kubectl-validate ./k8s-manifest/ --version 1.23 | |||
| ``` | |||
|
|
|||
|
|
|||
There was a problem hiding this comment.
Remove the extra empty line.
| @@ -76,6 +76,15 @@ If the version is not recognized, `kubectl-validate` will attempt to look up | |||
| the schemas for the selected version in the official upstream Kubernetes repository | |||
| on GitHub. | |||
|
|
|||
| ## overlay-schemas | |||
|
|
|||
| The ```--overlay-schemas``` option enables users to apply JSON patches onto resource schemas before they undergo validation. This feature allows for customizing the behavior of schema validation according to specific requirements. | |||
There was a problem hiding this comment.
@alexzielenski I'll let you review the line, you know the usage better than I do.
| The ```--overlay-schemas``` option enables users to apply JSON patches onto resource schemas before they undergo validation. This feature allows for customizing the behavior of schema validation according to specific requirements. | ||
|
|
||
| ```sh | ||
| kubectl-validate --overlay-schemas <patch_file> |
There was a problem hiding this comment.
I don't think the command is correct, aren't you supposed to specify some files you want to validate?
There was a problem hiding this comment.
@apelisse yes we are suppose to provide a file to validate this is exactly why I have written patch file in the < > so user can specify it by themselves
|
@swastik959 are you still working on this |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
added overlay-schema to readme.md
Which issue(s) this PR fixes:
Fixes #52
Special notes for your reviewer:
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: