Skip to content

Commit

Permalink
Docs: Update catalog with kustomize and kubeval
Browse files Browse the repository at this point in the history
  • Loading branch information
@prachirp
prachirp committed Jun 30, 2020
1 parent 3d454df commit 3dbdf87
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 7 deletions.
16 changes: 9 additions & 7 deletions site/content/en/guides/consumer/function/catalog/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@ These functions can be implemented using any toolchain such as the [Typescript S

See [definition of source functions][source].

| Image | Args | Description | Source | Toolchain |
| --------------------------------------------- | ----------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| gcr.io/kpt-dev/kpt | fn source | Reads a directory of Kubernetes configuration recursively. | [Link](https://github.com/kubernetes-sigs/kustomize/blob/master/cmd/config/internal/commands/source.go) | |
| gcr.io/kpt-functions/read-yaml | | [Demo] Reads a directory of Kubernetes configuration recursively. | [Link](https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/master/ts/demo-functions/src/read_yaml.ts) | [SDK](../../../producer/functions/ts) |
| gcr.io/cloud-builders/kubectl | get [...] -o yaml | Get one or many resources from a Kubernetes cluster. | [Link](https://github.com/GoogleCloudPlatform/cloud-builders/blob/master/kubectl/Dockerfile) | |
| gcr.io/kustomize-functions/create-application | | Add an Application CR to a group of resources. | [Link](https://github.com/kubernetes-sigs/kustomize/blob/master/functions/examples/application-cr/image/main.go) | [SDK](../../../producer/functions/golang) |
| Image | Args | Description | Source | Toolchain |
| --------------------------------------------- | --------------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| gcr.io/kpt-dev/kpt | fn source | Reads a directory of Kubernetes configuration recursively. | [Link](https://github.com/kubernetes-sigs/kustomize/blob/master/cmd/config/internal/commands/source.go) | |
| gcr.io/kpt-functions/read-yaml | | [Demo] Reads a directory of Kubernetes configuration recursively. | [Link](https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/master/ts/demo-functions/src/read_yaml.ts) | [SDK](../../../producer/functions/ts) |
| gcr.io/cloud-builders/kubectl | get [...] -o yaml | Get one or many resources from a Kubernetes cluster. | [Link](https://github.com/GoogleCloudPlatform/cloud-builders/blob/master/kubectl/Dockerfile) | |
| gcr.io/kustomize-functions/create-application | | Add an Application CR to a group of resources. | [Link](https://github.com/kubernetes-sigs/kustomize/blob/master/functions/examples/application-cr/image/main.go) | [SDK](../../../producer/functions/golang) |
| lyft/kustomizer:v3.3.0 | kustomize build [...] | Run kustomize to build configuration | [Link](https://github.com/lyft/kustomizer/blob/master/Dockerfile) | |

## Sinks

Expand All @@ -42,7 +43,8 @@ See [definition of sink functions][sink].
| gcr.io/kpt-functions/istioctl-analyze | | Istioctl analyze is a diagnostic tool that can detect potential issues with Istio configuration and output errors to the results field. | [Link](https://github.com/GoogleContainerTools/kpt-functions-catalog/blob/master/functions/ts/src/istioctl_analyze.ts) | [SDK](../../../producer/functions/ts) |
| gcr.io/kpt-functions/gatekeeper-validate | | Enforces OPA constraints on input objects. The constraints are also passed as part of the input to the function. | [Link](https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/master/go/pkg/functions/gatekeeper/validate.go) | [SDK](https://github.com/GoogleContainerTools/kpt-functions-sdk/tree/master/go/pkg/framework) |
| gcr.io/kpt-functions/validate-rolebinding | | [Demo] Enforces a blacklist of subjects in RoleBinding objects. | [Link](https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/master/ts/demo-functions/src/validate_rolebinding.ts) | [SDK](../../../producer/functions/ts) |
| gcr.io/kustomize-functions/example-validator-kubeval | | Validates that all containers have cpu and memory reservations set. | [Link](https://github.com/kubernetes-sigs/kustomize/blob/master/functions/examples/validator-kubeval/image/main.go) | [SDK](../../../producer/functions/golang) |
| gcr.io/kpt-functions/kubeval | | Validates configuration using kubeval. | [Link](https://github.com/GoogleContainerTools/kpt-functions-catalog/blob/master/functions/ts/src/kubeval.ts) | [SDK](../../../producer/functions/ts) |
| gcr.io/kustomize-functions/example-validator-kubeval | | [Demo] Validates that all containers have cpu and memory reservations set. | [Link](https://github.com/kubernetes-sigs/kustomize/blob/master/functions/examples/validator-kubeval/image/main.go) | [SDK](../../../producer/functions/golang) |
| gcr.io/kustomize-functions/example-validator | | Validates Kubernetes configuration files using schemas from the Kubernetes OpenAPI spec. | [Link](https://github.com/kubernetes-sigs/kustomize/blob/master/functions/examples/validator-resource-requests/image/main.go) | [SDK](../../../producer/functions/golang) |
| gcr.io/kpt-functions/suggest-psp | | [Demo] Lints PodSecurityPolicy by suggesting 'spec.allowPrivilegeEscalation' field be set to 'false'. | [Link](https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/master/ts/demo-functions/src/suggest_psp.ts) | [SDK](../../../producer/functions/ts) |

Expand Down
15 changes: 15 additions & 0 deletions site/content/en/guides/consumer/function/catalog/catalog/catalog.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@
"type": "source",
"toolchain": "../../../producer/functions/golang"
},
{
"image": "lyft/kustomizer:v3.3.0",
"args": "kustomize build [...]",
"source": "https://github.com/lyft/kustomizer/blob/master/Dockerfile",
"description": "Run kustomize to build configuration",
"type": "source"
},
{
"image": "gcr.io/kpt-dev/kpt",
"args": "fn sink",
Expand Down Expand Up @@ -65,11 +72,19 @@
"demo": true,
"toolchain": "../../../producer/functions/ts"
},
{
"image": "gcr.io/kpt-functions/kubeval",
"source": "https://github.com/GoogleContainerTools/kpt-functions-catalog/blob/master/functions/ts/src/kubeval.ts",
"description": "Validates configuration using kubeval.",
"type": "validator",
"toolchain": "../../../producer/functions/ts"
},
{
"image": "gcr.io/kustomize-functions/example-validator-kubeval",
"source": "https://github.com/kubernetes-sigs/kustomize/blob/master/functions/examples/validator-kubeval/image/main.go",
"description": "Validates that all containers have cpu and memory reservations set.",
"type": "validator",
"demo": true,
"toolchain": "../../../producer/functions/golang"
},
{
Expand Down

0 comments on commit 3dbdf87

Please sign in to comment.