This README is the one indexed from the repository at its latest ref, not from the tag for this version.

kube-helper

This is a basic CLI tool that asists in applying k8s configurations easily. Configuration is applied via the schema defined in a deployment.yml file.

Installation

Requirements

• kubectl (>= 1.18)
• helm (>= 3.0)
• crystal (>= 1.0.0)

Build

git clone https://github.com/spoved/kube-helper.git
cd kube-helper
shards build --ignore-crystal-version

Usage

To use kube-helper you need to create a deployment.yml definition. See the SPEC.md for examples and definition. Command line help is available via the --help flag.

$ ./bin/kube-helper --help
Usage: kube-helper [arguments]

    -h, --help                       Show this help
    --version                        Print version and exit

Config Flags:
    -w DIR, --workdir DIR            Working directory. default: "./"
    -f FILE, --file FILE             Name of config file. default: deployment.yml
    --kubeconfig FILE                Path to the kube config file. default: ${HOME}/.kube/config

Logging Flags:
    -q, --quiet                      Log errors only
    -v, --verbose                    Log verbose
    -d, --debug                      Log debug

Runtime Flags:
  general options:
    --all                            Apply all updates/changes
    -l, --list                       List groups and apps and exit
  apply/create specific resources:
    --ns, --namespaces               Create namespaces
    -m, --manifests                  Apply manifests
    -s, --secrets                    Apply secrets
    -c, --configmaps                 Apply configmaps
  filter resources:
    --groups                         Update only groups
    --apps                           Update only apps
    -g NAME, --group NAME            Only apply changes to specified group with NAME. (accepts multiple)
    -n NAME, --name NAME             Only apply changes to apps with this name.       (accepts multiple)
  local environment config:
    --helm                           Update helm repos
  destructive actions:
    --delete                         Delete app manifests

You can verify and see your current deployments in a easy to read table with the --list flag.

$ ./bin/kube-helper --list
╭─────────────┬────────────────┬────────────────┬─────────╮
│ Group       │ Name           │ Namespace      │ Ignored │
├─────────────┼────────────────┼────────────────┼─────────┤
│ production  │ sidekiq-web    │ production     │ false   │
│ production  │ vault          │ production     │ false   │
│ development │ sidekiq-web    │ development    │ false   │
│ development │ vault          │ development    │ false   │
│ ---         │ minio-operator │ minio-operator │ false   │
╰─────────────┴────────────────┴────────────────┴─────────╯

Applying all configurations can be done with --all or select items can be selected for:

# Apply only items in the production group
$ ./bin/kube-helper -g production

# Apply only apps named vault
$ ./bin/kube-helper -n vault

# Apply only apps named vault in the group production
$ ./bin/kube-helper -g production -n vault

Order items are applied

When using --all there is a default order top items are applied:

• helm - Local helm repos are updated
• namespaces - Namespaces are created/updated
• secrets
• config_maps
• manifests
• apps
• groups

For more granular control use groups or apps to define your application. They both support the before and after manifest lists to allow when you need a resource to be applied/created. When processing groups or apps it will process sub items in order (top to bottom).

Contributing

1. Fork it (https://github.com/spoved/kube-helper/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Holden Omans - creator and maintainer