mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-05-17 18:25:26 +00:00
updated documentation
This commit is contained in:
36
kyaml/openapi/README.md
Normal file
36
kyaml/openapi/README.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Sampling New OpenAPI Data
|
||||
|
||||
[kyaml]: ../
|
||||
[OpenAPI schema]: ./kubernetesapi/swagger.json
|
||||
[home]: ../../
|
||||
|
||||
This document describes how to fetch OpenAPI data from
|
||||
a particular kubernetes version number.
|
||||
|
||||
###Fetching the Schema
|
||||
In the [kyaml] directory, fetch the schema
|
||||
```
|
||||
make schema
|
||||
```
|
||||
|
||||
You can specify a specific version with the "VERSION"
|
||||
parameter. The default version is v1.19.1. Here is an
|
||||
example for fetching the data for v1.14.1.
|
||||
```
|
||||
make schema VERSION=v1.14.1
|
||||
```
|
||||
|
||||
This will update the [OpenAPI schema].
|
||||
|
||||
###Generating Swagger.go
|
||||
In the [kyaml] directory, generate the swagger.go files.
|
||||
```
|
||||
make openapi
|
||||
```
|
||||
|
||||
###Run all tests
|
||||
In the [home] directory, run the tests.
|
||||
```
|
||||
make prow-presubmit-check >& /tmp/k.txt; echo $?
|
||||
# The exit code should be zero; if not examine /tmp/k.txt
|
||||
```
|
||||
@@ -10,6 +10,7 @@
|
||||
[semver release]: #semver-review
|
||||
[`cloudbuild.yaml`]: cloudbuild.yaml
|
||||
[kustomize repo release page]: https://github.com/kubernetes-sigs/kustomize/releases
|
||||
[OpenAPI Readme]: ../kyaml/openapi/README.md
|
||||
|
||||
This document describes how to perform a [semver release]
|
||||
of one of the several [Go modules] in this repository.
|
||||
@@ -142,6 +143,10 @@ this should be automated, and descriptions in PR's should
|
||||
be standardized to make automation possible.
|
||||
See kubebuilder project.
|
||||
|
||||
#### Fetching New OpenAPI Data
|
||||
The Kubernetes OpenAPI data changes once per quarter. Instructions
|
||||
on how to get a new OpenAPI sample can be found in the
|
||||
[OpenAPI Readme].
|
||||
|
||||
## Public Modules
|
||||
|
||||
|
||||
Reference in New Issue
Block a user