Skip to content

Commit

Permalink
Add screenshot of api-resources, fix typo and prevent future typos
Browse files Browse the repository at this point in the history
  • Loading branch information
imjasonh committed May 4, 2021
1 parent 8998f08 commit 02e3450
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
12 changes: 12 additions & 0 deletions .github/workflows/misspell.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Spellcheck
on: [pull_request]
jobs:
misspell:
name: misspell
runs-on: ubuntu-latest
steps:
- name: Check out code.
uses: actions/checkout@v1
- name: misspell
uses: reviewdog/action-misspell@v1

5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@ By default, `kcp` only knows about:
- [`CustomResourceDefinitions`](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/), to define new types
- a handful of other low-level resources like [`Lease`](https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/lease-v1/)s, [`Event`](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-application-introspection/)s, etc.

<!-- TODO link to full list? -->
![kubectl api-resources showing minimal API resources](./docs/images/kubectl-api-resources.png)

Like vanilla Kubernetes, `kcp` persists these resources in etcd for durable storage.

Any other resource, including Kubernetes-standard resources like `Pod`s, `Node`s and the rest, can be added as [CRDs](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) and reconciled using the standard conrtollers.

Any other resources, including Kubernetes-standard resources like `Pod`s, `Node`s and the rest, can be added as [CRDs](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) and reconciled using the standard controllers.

## Why would I want that?

Expand Down
Binary file added docs/images/kubectl-api-resources.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 02e3450

Please sign in to comment.