Skip to content

Commit

Permalink
docs: Update docs for new openapi kustomize support (#2216)
Browse files Browse the repository at this point in the history
* docs: Update docs for new openapi kustomize support

Signed-off-by: zachaller <zachaller@hotmail.com>

* update required kustomize version

Signed-off-by: zachaller <zachaller@hotmail.com>

Signed-off-by: zachaller <zachaller@hotmail.com>
  • Loading branch information
zachaller committed Sep 6, 2022
1 parent 669f961 commit 3f0dab0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/features/kustomize.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ configurations:
- https://argoproj.github.io/argo-rollouts/features/kustomize/rollout-transform.yaml
```

- With Kustomize 4.1.0 kustomize can use kubernetes OpenAPI data to get merge key and patch strategy information about [resource types](https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/openapi). For example, given the following rollout:
- With Kustomize 4.5.5 kustomize can use kubernetes OpenAPI data to get merge key and patch strategy information about [resource types](https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/openapi). For example, given the following rollout:

```yaml
apiVersion: argoproj.io/v1alpha1
Expand Down Expand Up @@ -63,7 +63,7 @@ resources:
- rollout-canary.yaml

openapi:
path: <path-to-directory>/rollout_cr_schema.json
path: https://raw.githubusercontent.com/argoproj/argo-schema-generator/main/schema/argo_all_k8s_kustomize_schema.json

patchesStrategicMerge:
- |-
Expand All @@ -79,7 +79,7 @@ patchesStrategicMerge:
image: nginx
```

The OpenAPI data is auto-generated and defined in this [file](https://github.com/argoproj/argo-rollouts/blob/master/docs/features/kustomize/rollout_cr_schema.json).
The OpenAPI data is auto-generated and defined in this [file](https://github.com/argoproj/argo-schema-generator/blob/main/schema/argo_all_k8s_kustomize_schema.json).

An example kustomize app demonstrating the ability to use OpenAPI data with Rollouts can be seen
[here](https://github.com/argoproj/argo-rollouts/blob/master/test/kustomize/rollout).
2 changes: 1 addition & 1 deletion test/kustomize/rollout/kustomization.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ images:
newTag: v2

openapi:
path: ../../../docs/features/kustomize/rollout_cr_schema.json
path: https://raw.githubusercontent.com/argoproj/argo-schema-generator/main/schema/argo_all_k8s_kustomize_schema.json

patchesStrategicMerge:
- |-
Expand Down

0 comments on commit 3f0dab0

Please sign in to comment.