kind-deployment

This repository provides a simple and fast way to run Cloud Foundry locally. It enables developers to rapidly prototype, develop, and test new ideas in an inexpensive setup.

Prerequisites

The following tools need to be installed:

• docker or podman
• docker-compose or podman-compose
• make:
  • It should be already installed on MacOS and Linux.
  • For Windows installation see: https://gnuwin32.sourceforge.net/packages/make.htm

Important

Please ensure that your Podman setup is configured as an alias for Docker, as this project relies on Docker commands. You can achieve this by executing sudo ln -s /opt/podman/bin/podman /usr/local/bin/docker and sudo ln -s /opt/homebrew/bin/podman-compose /usr/local/bin/docker-compose on Mac OS X.

Run the Installation

make up

Access and Bootstrap CloudFoundry

# Login via CF CLI and create a test space
make login

# Upload Java, Node, Go, and Binary buildpacks
# 'make bootstrap-complete' would upload all buildpacks
make bootstrap

Deploy a Sample Application

cf push -f examples/hello-js/manifest.yaml

Delete the Installation

make down

Configuration

You can configure the installation by setting the environment variable INSTALL_OPTIONAL_COMPONENTS=false to leave out these optional components:

bosh-dns, cf-tcp-router, credhub, loggregator, nfsbroker, policy-agent, policy-server, routing-api, service-discovery-controller

Custom Helmfile values

Set ADDITIONAL_VALUES_FILES environment variable to a comma-separated list of Helmfile values files. They are merged last, so they can override any value in values.yaml.gotmpl (domains, CNI, chart versions, etc.).

ADDITIONAL_VALUES_FILES=./my-values.yaml make up

PostgreSQL configuration

The postgresql value is passed to the PostgreSQL chart. For example, to raise max_connections (default 100), put this in a values file and use it via ADDITIONAL_VALUES_FILES (or the additional-values-files input of the setup-cf action):

postgresql:
  primary:
    extendedConfiguration: |
      max_connections = 500

Using the setup-cf GitHub Action

This repository ships a composite action at .github/actions/setup-cf that provisions a full Cloud Foundry environment on a KinD cluster inside a GitHub Actions workflow. After it completes, the generated credentials from temp/secrets.env are exported into $GITHUB_ENV, so later steps can use the CF CLI directly.

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: cloudfoundry/kind-deployment/.github/actions/setup-cf@main
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
      - run: cf push -f examples/hello-js/manifest.yaml

Inputs (all optional):

• isolated-cell (boolean, default false): add an isolated worker cell for routing isolation segment tests.
• install-optional-components (boolean, default true): install optional CF components.
• cf-cli-version (string, default 8.19.0): CF CLI version to install.
• github-token (string): GitHub API token, used when use-latest-versions is enabled to avoid rate limiting.
• ref (string, default main): kind-deployment branch, tag or commit SHA that is checked out and deployed. Set it to the same commit as the action's @<sha> to get a fully pinned setup.
• use-latest-versions (boolean, default false): sync to the latest develop versions of cf-deployment before deploying.
• additional-values-files (string, default ''): comma-separated list of Helmfile values files, merged last. Use it to override any value, e.g. a chart version (charts.capi.version). Must be absolute paths, e.g. ${{ github.workspace }}/capi-values.yaml, since Helmfile runs from the checked-out kind-deployment directory.

Unsupported Features

• Routing isolation segments are not fully feature complete since this relies on more than one gateway which is not possible to realize in a local kind setup (see FAQ)

Read More Documentation

• Local Development Guide
• FAQs

Contributing

Please check our contributing guidelines.

This project follows Cloud Foundry Code of Conduct.