Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudfoundry-incubator/kubecf
Cloud Foundry on Kubernetes
https://github.com/cloudfoundry-incubator/kubecf
Last synced: 21 days ago
JSON representation
Cloud Foundry on Kubernetes
- Host: GitHub
- URL: https://github.com/cloudfoundry-incubator/kubecf
- Owner: cloudfoundry-incubator
- License: apache-2.0
- Archived: true
- Created: 2019-10-17T07:02:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-25T20:44:47.000Z (about 3 years ago)
- Last Synced: 2024-02-23T10:35:33.616Z (4 months ago)
- Language: Shell
- Size: 3.9 MB
- Stars: 116
- Watchers: 29
- Forks: 65
- Open Issues: 205
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Lists
- awesome-stars - kubecf - incubator | 117 | (Shell)
- awesome-starred - cloudfoundry-incubator/kubecf - Cloud Foundry on Kubernetes (others)
- awesome-stars - kubecf - incubator | 100 | (Shell)
README
# KubeCF
| Build step | State |
| --- | --- |
| Linting | [](https://concourse.suse.dev/teams/main/pipelines/kubecf/jobs/lint-master/) |
| Building | [](https://concourse.suse.dev/teams/main/pipelines/kubecf/jobs/build-master/) |
| Smoke tests on Diego | [](https://concourse.suse.dev/teams/main/pipelines/kubecf/jobs/smoke-tests-diego-master/) |
| Smoke tests on Eirini | [](https://concourse.suse.dev/teams/main/pipelines/kubecf/jobs/smoke-tests-eirini-master/) |
| Acceptance Tests on Diego | [](https://concourse.suse.dev/teams/main/pipelines/kubecf/jobs/cf-acceptance-tests-diego-master/) |
| Acceptance Tests on Eirini | [](https://concourse.suse.dev/teams/main/pipelines/kubecf/jobs/cf-acceptance-tests-eirini-master/) |
## Introduction
KubeCF is a distribution of Cloud Foundry Application Runtime (CFAR) for Kubernetes.
It works with the [cf-operator] from [Project Quarks] to deploy and manage releases built from [cf-deployment].
[cf-operator]: https://github.com/cloudfoundry-incubator/cf-operator/
[Project Quarks]: https://www.cloudfoundry.org/project-quarks/
[cf-deployment]: https://github.com/cloudfoundry/cf-deployment/
[Docs]: https://kubecf.io/
## Documentation
The Community documentation website is [available here](https://kubecf.io/).
## Contributing to KubeCF development
See the [Guide to Contribution](doc/Contribute.md).
# System requirements
To work with `kubecf`, a variety of supporting tools are required.
These are:
| Tool | Notes |
|--- |--- |
|k8s | The platform to run KubeCF. |
|minikube | Provider for local k8s clusters. |
|kind | Provider for local k8s clusters. |
|kubectl | Client to talk to k8s clusters. |
|Helm | Handling helm charts. |
|[cf-operator] | Processes BOSH deployments. Maps them to kube objects. |
|[cf-deployment]| The CF release at the core of `kubecf`. |
As most of the developers use the `Make & Bash` build system coming with the
`kubecf` repository, they implicitly use the versions for the tools
set down in __scripts/tools/*__. At the time of writing, these are:
At the time of this writing these were:
| Tool | Version | Notes |
|---------------|---------------------|-------|
| Kubernetes | 1.17.5 | |
| minikube | 1.9.2 | |
| kind | 0.6.0 | |
| kubectl | 1.17.0 | |
| Helm | 3.0.3 | |
| jq | 1.6 | |
| python3 | 3.3 | |
| ruby | 2.4 | |
| shellcheck | 0.7.0 | |
| yamllint | 1.23 | |
| CF Operator | 6.1.17+0.gec409fd7 | |
| cf-deployment | 13.17.0 | |
__Note however__: As `kubecf` is updated these versions may change
from commit to commit. The table above is therefore
__not authoritative__.
__Always__ check the contents of __dependencies.yaml__ and
__scripts/tools/*__ for the authoritative answer.
__Note further__: Just because the build system provides targets to
conveniently bring up a local k8s cluster using minikube or kind, this
does not preclude the use of other k8s cluster providers, local or in
the cloud.
Besides the required tools noted above, other tools used by developers
are:
| Tool | Notes | Location |
|--- |--- |--- |
|k9s | Curses-based UI over kubectl | https://github.com/derailed/k9s |
|stern | Multi-pod log tailing | https://github.com/wercker/stern |
Last, but not least, __more documentation__ on how to work with
`kubecf` is found in the [Guide to Contribution](doc/Contribute.md).
## Useful Information
| What | Where |
| -------------------------------------- | ------------------------------------------------------------ |
| Concourse Pipeline | https://concourse.suse.dev/teams/main/pipelines/kubecf |
| S3 Bucket with helm charts* | https://kubecf.s3.amazonaws.com/index.html |
| Cloud Foundry Operator | https://github.com/cloudfoundry-incubator/cf-operator/ |
| CF Operator Charts | https://cf-operators.s3.amazonaws.com/helm-charts/index.html |
* The bundle file includes the operator chart