Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 1.59 KB

development.md

File metadata and controls

44 lines (31 loc) · 1.59 KB
Raw

Developing cf-for-k8s

This document is intended for cf-for-k8s maintainers and contributors.

Dependencies

Templating and Deployment

Smoke Tests

Vendoring

  • vendir v0.7.0+ (includes the directory flag, used in the development workflow)

Smoke tests

To run:

cd tests/smoke
SMOKE_TEST_API_ENDPOINT=https://api.system.cf.example.com SMOKE_TEST_USERNAME=admin SMOKE_TEST_PASSWORD=cfadminpassword SMOKE_TEST_APPS_DOMAIN=apps.cf.example.com ginkgo ./...

Directory structure

  • config/ includes all necessary configuration for CF
    • _ytt_lib/ includes unmodified configuration fetched from components' repos (controlled via /vendir.yml)
    • values.yml specifies all possible data values used
    • *.yml includes configuration to glue components together
  • build/ includes building instructions for components that do not provide plain YAML or ytt templates
    • this directory is only used by cf-for-k8s maintainers
    • build.sh in each sub-directory has specific build instructions

Image References

Image references are expected to use an image SHA digest. If using kbld to build images as suggested in the component development flow, the image reference should include the digest by default.

Tips

  • alias k=kubectl
    • useful alias
  • kubectl get pod -A -o custom-columns='NAME:metadata.name,INITCONS:spec.initContainers[*].image,CONS:spec.containers[*].image'
    • show all used images in pods