Skip to content

Commit

Permalink
Merge pull request #4 from manning-ncsa/patch-1
Browse files Browse the repository at this point in the history
Minor English language improvements in docs
  • Loading branch information
cppforlife authored Apr 28, 2020
2 parents 6ec4c4e + a71feb7 commit 46a404d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 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.
Grab the 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:

Expand All @@ -10,11 +10,11 @@ or
$ kubectl apply -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.
**Note**: By default kapp controller allows you 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.
`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 the kapp controller configuration if the defaults do not not fit your needs.

Example:

Expand Down
8 changes: 4 additions & 4 deletions docs/walkthrough.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Walkthrough

Goal of this walkthrough is to demonstrate how to install a simple example application, an HTTP server, on Kubernetes with kapp-controller. We will use `examples/simple-app-git` directory as our YAML configuration.
The goal of this walkthrough is to demonstrate how to install a simple example application, an HTTP server, on Kubernetes with kapp-controller. We will use `examples/simple-app-git` directory as our YAML configuration.

You can use `kubectl` (or another tool) to deploy YAML examples below. We've chosen [kapp](https://get-kapp.io).
You can use `kubectl` (or another tool) to deploy the YAML examples below. We've chosen [kapp](https://get-kapp.io).

- Start by [installing](install.md) kapp-controller onto cluster
- Start by [installing](install.md) kapp-controller onto your cluster

- Install [examples/simple-app-git/1.yml](https://github.com/k14s/kapp-controller/blob/master/examples/simple-app-git/1.yml) App CR. It specifies how to fetch, template, and deploy our example application.

Expand Down Expand Up @@ -35,7 +35,7 @@ Succeeded

- Check out `kubectl get app` output to see that app is deployed.

- Additionally, let's check status of our App CR. It shows overall status of the application, including latest deploy output (`status.deploy.stdout`), and latest inspect output (`status.inspect.stdout`). Based on inspect output we can see that our app included a `Deployment` and a `Service`.
- Additionally, let's check status of our App CR. It shows the overall status of the application, including the latest deploy output (`status.deploy.stdout`) and latest inspect output (`status.inspect.stdout`). Based on the inspect output we can see that our app included a `Deployment` and a `Service`.

```bash
$ kapp inspect -a simple-app --status
Expand Down
10 changes: 5 additions & 5 deletions docs/why.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
## Why

Given application configuration for Kubernetes software could be specified in various forms:
Given that application configurations for Kubernetes software can be specified in various forms:

- plain YAML configurations
- Helm charts
- ytt templates
- jsonnet templates
- etc.

and is found in various locations:
and found in various locations:

- Git repository
- Archive over HTTP
- Helm repository
- etc.

and is written/provided by:
and written/provided by:

- in-house development teams
- vendors offering COTS products

as a Kubernetes user I would like to customize, install, and update such software in a _consistent_ and _manageable_ manner.

kapp-controller provides a Kubernetes native way, via App CRD, to specify how to fetch, configure and finally deploy software it to the cluster.
kapp-controller provides a Kubernetes native way, via App CRD, to specify how to fetch, configure and deploy software to the cluster.

Another motivation for kapp-controller was to make a small and single purpose system (as opposed to a general CD system); hence, it's lightweight, easy-to-understand and easy-to-debug. It builds on small composable tools to achieve its goal and therefore is easy to think about.

Finally, for the fans of GitOps, kapp-controller turns [kapp](https://get-kapp.io) into your continious cluster reconciler.
Finally, for the fans of GitOps, kapp-controller turns [kapp](https://get-kapp.io) into your continuous cluster reconciler.

Next: [Install](install.md)

0 comments on commit 46a404d

Please sign in to comment.