Project Layout

What are the files in the KubeCF project?

The important directories of the KubeCF sources, and their contents are shown in the table below. Each directory entry links to the associated documentation, if we have any.

Directory Content
top Documentation entrypoint, License,
Main workspace definitions.
top/…/README.md Directory-specific local documentation.
top/bosh/releases Support for runtime patches of a kubecf deployment.
top/doc Global documentation.
top/dev/cf_deployment/bump Tools to support updating the cf deployment
manifest used by kubecf.
top/dev/cf_cli Deploy cf cli into a helper pod from which to then
inspect the deployed Kubecf
top/dev/kube Tools to inspect kube clusters and kubecf deployments.
top/dev/linters Tools for statically checking the kubecf sources.
top/dev/minikube Targets to manage a local kubernetes cluster.
Minikube based.
top/dev/kind Targets to manage a local kubernetes cluster.
KinD based (Kube-in-Docker).
top/dev/kubecf Kubecf chart configuration, and targets for
local chart application.
top/deploy/helm/kubecf Templates and assets wrapping a CF deployment
manifest into a helm chart.
top/rules Supporting bazel definitions.
top/testing Bazel targets to run CF smoke and acceptance tests.

CF Bump scripts

Tools to support updating the cf deployment manifest used by KubeCF

CF CLI script

Deploy cf cli into a helper pod from which to then inspect the deployed Kubecf

Inspection Helpers

Helpers to inspect kube clusters and KubeCF deployments.

Kind

Targets to manage a local Kind kubernetes cluster

KubeCF

Kubecf chart configuration, and targets for local chart application.

Linters

Tools for statically checking the kubecf sources

Minikube

Targets to manage a local Minikube kubernetes cluster

Pre-render scripts

Support for runtime patches of a kubecf deployment.

Testing

Bazel targets to run CF smoke and acceptance tests.

Last modified December 19, 2019: Integrating remaining existing docs (961159c)