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

added overlay-schema to readme.md #93

Closed
wants to merge 2 commits into from
Closed

added overlay-schema to readme.md #93

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94f35cc
added overlay-schema to readme.md
swastik959 Feb 23, 2024
18e522d
corrected tweeks
swastik959 Feb 27, 2024
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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turn this into a title rather than a slug?


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexzielenski I'll let you review the line, you know the usage better than I do.


```sh
kubectl-validate --overlay-schemas <patch_file>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the command is correct, aren't you supposed to specify some files you want to validate?

Copy link
Contributor Author

@swastik959 swastik959 Mar 2, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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

```


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra empty line

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra empty line

## CRD

`kubectl-validate` is also capable of validating CRDs. To do that, it needs to be
Expand Down Expand Up @@ -186,6 +195,7 @@ jobs:
run: kubectl-validate ./k8s-manifest/ --version 1.23
```


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the extra empty line.

## Docker

This project doesn't have a native docker image (yet), but you can use the given Dockerfile to build one.
Expand Down