Skip to content

Commit

Permalink
Update docs for v0.3.2
Browse files Browse the repository at this point in the history
  • Loading branch information
danopia committed Dec 2, 2021
1 parent 8039d4c commit 6a34d69
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,14 @@ There's also third-party projects that register CRDs, such as cert-manager.
OpenAPI specs are almost never published by these projects,
so generating APIs for them generally means feeding CRD YAML files into the codegen and guessing.
This is an imperfect art but so far works well for `cert-manager` and `exernal-dns`.
Alternatively, the CRDs could be installed onto a real control plane and then the APIed extracted.
Alternatively, the CRDs could be installed onto a real control plane and then the APIs extracted.

Several examples of addressing third party APIs might be:

* `https://k8s-apis.deno.dev/v1/cert-manager@v1.0.4/acme.cert-manager.io@v1alpha2/mod.ts`
* `https://k8s-apis.deno.dev/v1/external-dns@v0.7.4/externaldns.k8s.io@v1alpha1/mod.ts`
* `https://k8s-apis.deno.dev/v1/velero@v1.5.2/velero.io@v1/mod.ts`
* `https://k8s-apis.deno.dev/v1/argo-cd@v2.1.7/argoproj.io@v1alpha1/mod.ts`

The only sort of 'directory' of CRDs is likely [Operator Hub](https://operatorhub.io/)
though it is also lacking CRDs that are not explicitly tied to an "Operator".
Expand Down
14 changes: 9 additions & 5 deletions lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,20 @@ console.log(podList);
// see files in examples/ for more API demos (watching, creation, etc)
```

When running locally (with `kubectl` set up), you probably just to add `--allow-run` to run this.
When running locally (with `kubectl` set up), you probably just to add `--allow-run=kubectl` to run this.
For a container being deployed onto a cluster, there's more flags to provide instead;
see `/x/kubernetes_client` for more information.

NOTE: Although the APIs all accept an `AbortSignal`,
Deno's `fetch()` function does not yet support `AbortSignal` and
cancelling API calls is thus not well-supported at this time.

## Changelog

* `v0.3.2` on `2021-12-02`:
* Updating `/x/kubernetes_client` API contract to `v0.3.2`.
* Includes 'builtin' APIs generated from K8s `v1.22.4`.
* Numerous `v1beta1` API versions were removed in favor of stable `v1` APIs.
* Further API changes are detailed in Github Releases.
* `cert-manager` and `external-dns` CRDs have been updated from the latest releases.
* Added CRDs for `argo-cd`.

* `v0.3.1` on `2021-05-09`:
* Updating `/x/kubernetes_client` API contract to `v0.2.4`.
* Includes 'builtin' APIs generated from K8s `v1.21.0`.
Expand Down

0 comments on commit 6a34d69

Please sign in to comment.