Skip to content

Commit

Permalink
Update readme with docker images
Browse files Browse the repository at this point in the history
Signed-off-by: Xabier Larrakoetxea <me@slok.dev>
  • Loading branch information
slok committed Feb 20, 2020
1 parent b2fd31f commit e92801e
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,26 @@ A kubernetes code generator ready container to create your CRD autogenerated cod

This uses the [official util](https://github.com/kubernetes/code-generator) created by Kubernetes to autogenerate the code required by Kubernetes resources.

## Docker image versions

| | Docker image |
| ----------------- | -------------------------------------------------------- |
| Kubernetes v1.9 | `docker pull quay.io/slok/kube-code-generator:v1.9.1` |
| Kubernetes v1.10 | `docker pull quay.io/slok/kube-code-generator:v1.10.0` |
| Kubernetes v1.11 | `docker pull quay.io/slok/kube-code-generator:v1.11.3` |
| Kubernetes v1.12 | `docker pull quay.io/slok/kube-code-generator:v1.12.4` |
| Kubernetes v1.13 | `docker pull quay.io/slok/kube-code-generator:v1.13.5` |
| Kubernetes v1.14 | `docker pull quay.io/slok/kube-code-generator:v1.14.2` |
| Kubernetes v1.15 | `docker pull quay.io/slok/kube-code-generator:v1.15.10` |
| Kubernetes v1.16 | `docker pull quay.io/slok/kube-code-generator:v1.16.7` |

## Getting started

The best way to start is by checking an [example](example/) of how
to generate Go code for a CRD.

For a detailed explanation of how to use it continue reading.

## Kubernetes type code generation

### Env vars required
Expand Down Expand Up @@ -49,7 +69,3 @@ docker run -it --rm \
-e OPENAPI_OUTPUT_PACKAGE=${PROJECT_PACKAGE}/openapi \
quay.io/slok/kube-code-generator ./update-openapi.sh
```

## Example

You have a project example in [example](example/) path.

0 comments on commit e92801e

Please sign in to comment.