Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maorfr committed Sep 16, 2018
1 parent ed4b647 commit 90b617f
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,20 @@ glide up -v
go build -o orca cmd/orca.go
```

## Commands

The following commands are available:
```
delete env Delete an environment (Kubernetes namespace) along with all Helm releases in it
delete resource Delete a resource from REST API
deploy chart Deploy a Helm chart from chart repository
deploy env Deploy a list of Helm charts to an environment (Kubernetes namespace)
determine buildtype Determine build type based on path filters
get env Get list of Helm releases in an environment (Kubernetes namespace)
get resource Get a resource from REST API
push chart Push Helm chart to chart repository
```

## Examples

### Build type determination
Expand All @@ -32,6 +46,18 @@ orca determine buildtype \
--prev-commit <previousCommitHash>
```

In this example, if the current reference is different from the mainline and a release branch, the build type will be set to `default`:
```
orca determine buildtype \
--default-type default \
--curr-ref develop \
--main-ref master \
--rel-ref ^.*/rel-.*$
```

The two examples can be combined.


### Get resource
This function gets a resource from REST API.

Expand All @@ -40,12 +66,27 @@ In this example, it gets the previous commit hash (offset of 1 from the current
```
orca get resource \
--url <pipelinesURL> \
--headers "<header>:<value>" \
--key sha \
--value <currentCommit> \
--offset 1 \
--print-key sha
```

### Get env
This functions gets all Helm installed releases from an environment (Kubernetes namespace).

In this example, only orca managed releases will be displayed (a managed release is considered one with release name in the form of namespace-chartName):

```
orca get env \
--kube-context <kubeContext> \
--name <namespace>
```

You can add the `--only-managed=false` to show all releases in a namespace.


### Deploy chart
This function deploys a Helm chart from a chart repository, using values files which are packed along with the chart.

Expand Down

0 comments on commit 90b617f

Please sign in to comment.