diff --git a/.github/assets/squadron.png b/.github/assets/squadron.png new file mode 100644 index 0000000..1caa5f4 Binary files /dev/null and b/.github/assets/squadron.png differ diff --git a/LICENSE b/LICENSE index cba6e17..701540f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2021 Foomo web framework +Copyright (c) 2021 foomo by bestbytes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 7499b15..9eb030f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ -# Squadron - [![Build Status](https://github.com/foomo/squadron/actions/workflows/pr.yml/badge.svg?branch=main&event=push)](https://github.com/foomo/squadron/actions/workflows/pr.yml) [![Go Report Card](https://goreportcard.com/badge/github.com/foomo/squadron)](https://goreportcard.com/report/github.com/foomo/squadron) [![Coverage Status](https://coveralls.io/repos/github/foomo/squadron/badge.svg?branch=main&)](https://coveralls.io/github/foomo/squadron?branch=main) [![GoDoc](https://godoc.org/github.com/foomo/squadron?status.svg)](https://godoc.org/github.com/foomo/squadron) +
+ +
+ +# Squadron + 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 +## Configuration `squadron.yaml` Configure your squadron @@ -68,29 +72,39 @@ squadron: image: docker.mycompany.com/mycomapny/backend:latest ``` -Install the squadron squadron and namespace: - -```text -$ squadron up --build --push --namespace default -``` - -Uninstall the squadron again: - -```text -$ squadron down -``` - -## Commands +## Usage -```text -# See: +```shell $ squadron help +Usage: + squadron [command] + +Available Commands: + build build or rebuild squadron units + completion Generate completion script + config generate and view the squadron config + diff shows the diff between the installed and local chart + down uninstalls the squadron or given units + help Help about any command + list list squadron units + push pushes the squadron or given units + rollback rolls back the squadron or given units + schema generate squadron json schema + status installs the squadron or given units + template render chart templates locally and display the output + up installs the squadron or given units + version show version information + +Flags: + -d, --debug show all output + -f, --file strings specify alternative squadron files (default [squadron.yaml]) + -h, --help help for squadron + -s, --silent only show errors + -v, --verbose show more output + +Use "squadron [command] --help" for more information about a command. ``` -## See also - -Sometimes as a sailor or a pirate you might need to get a grapple : go get [github.com/foomo/gograpple/...](https//:github.com/foomo/gograpple) - ## How to Contribute Make a pull request... @@ -98,3 +112,5 @@ Make a pull request... ## License Distributed under MIT License, please see license file within the code for more details. + +_Made with ♥ [foomo](https://www.foomo.org) by [bestbytes](https://www.bestbytes.com)_