squadron/README.md
2024-09-25 23:39:06 +02:00

2.3 KiB

Squadron

Build Status Go Report Card Coverage Status GoDoc

Application for managing kubernetes microservice environments.

Use it, if a helm chart is not enough in order to organize multiple services into an effective squadron.

Another way to think of it would be helm-compose, because it makes k8s and helm way more approachable, not matter if it is development or production (where it just becomes another helm chart)

Quickstart

Configure your squadron

# squadron.yaml
version: '2.0'

squadron:
  site:
    frontend:
      chart:
        name: mychart
        version: 0.1.0
        repository: http://helm.mycompany.com/repository
      builds:
        service:
          tag: latest
          file: Dockerfile
          image: docker.mycompany.com/mycomapny/frontend
          build_arg:
            - "foo=foo"
            - "bar=bar"
      values:
        image: docker.mycompany.com/mycomapny/frontend:latest
    backend:
      chart: <% env "PROJECT_ROOT" %>/path/to/chart
      kustomize: <% env "PROJECT_ROOT" %>/path/to/kustomize
      builds:
        service:
          tag: latest
          file: Dockerfile
          image: docker.mycompany.com/mycomapny/backend
          build_arg:
            - "foo=foo"
            - "bar=bar"
      values:
        image: docker.mycompany.com/mycomapny/backend:latest

Install the squadron squadron and namespace:

$ squadron up --build --push --namespace default

Uninstall the squadron again:

$ squadron down

Commands

# See:
$ squadron help

See also

Sometimes as a sailor or a pirate you might need to get a grapple : go get github.com/foomo/gograpple/...

How to Contribute

Make a pull request...

License

Distributed under MIT License, please see license file within the code for more details.