Skip to content

Commit

Permalink
add install directions
Browse files Browse the repository at this point in the history
  • Loading branch information
cppforlife committed Dec 2, 2019
1 parent d89a47f commit bacfda7
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 17 deletions.
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
# kapp-controller

- Slack: [#k14s in Kubernetes slack](https://slack.kubernetes.io)
- [Docs](docs/README.md) with topics about config, etc.
- Install: see below section
- [Docs](docs/README.md) with topics about installation, config, etc.
- Install: see [Install instructions](docs/install.md)

kapp controller provides a way to specify which applications should run on your K8s cluster. It will install, and continiously apply updates.

Features:
- supports fetching Helm charts (via `helm fetch`), git repos (via `git`), Docker images (via [imgpkg](https://github.com/k14s/imgpkg)), inline content within resource
- supports templating of Helm charts, [ytt](https://get-ytt.io) configuration
- installs and syncs resources with [kapp](https://get-kapp.io)

## Development & Deploy

Install ytt, kbld, kapp beforehand (https://k14s.io).

```
./hack/build.sh # to build locally
# add `-v image_repo=docker.io/username/kapp-controller` with your registry to ytt invocation inside
./hack/deploy.sh # to deploy
export KAPPCTRL_E2E_NAMESPACE=kappctrl-test
./hack/test-all.sh
```
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## Docs

- [Install](install.md)
- [Config](config.md)
- [App spec](app-spec.md)
- [App CRD spec](app-spec.md)
13 changes: 13 additions & 0 deletions docs/dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Development & Deploy

Install ytt, kbld, kapp beforehand (https://k14s.io).

```
./hack/build.sh # to build locally
# add `-v image_repo=docker.io/username/kapp-controller` with your registry to ytt invocation inside
./hack/deploy.sh # to deploy
export KAPPCTRL_E2E_NAMESPACE=kappctrl-test
./hack/test-all.sh
```
22 changes: 22 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Install

Grab latest copy of YAML from the [Releases page](https://github.com/k14s/kapp-controller/releases) and use your favorite deployment tool (such as [kapp](https://get-kapp.io) or kubectl) to install it.

Example:

```bash
$ kapp deploy -a kc -f https://github.com/k14s/kapp-controller/releases/download/v0.1.0/release.yml
```

Note: By default kapp controller allows to install any piece of Kubernetes configuration, hence `release.yml` includes ClusterRole that allows modification of all resources in the cluster. Limit them appropriately based on your needs.

### Advanced

`release.yml` is produced with [ytt](https://get-ytt.io) and [kbld](https://get-kbld.io) at the time of the release. You can use these tools yourself and customize kapp controller configuration if default one does not fit your needs.

Example:

```
$ git clone ...
$ kapp deploy -a kc -f <(ytt -f config/ | kbld -f-)
```

0 comments on commit bacfda7

Please sign in to comment.