-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
18 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,10 @@ | ||
# helm Orb [![CircleCI status](https://circleci.com/gh/CircleCI-Public/helm-orb.svg "CircleCI status")](https://circleci.com/gh/CircleCI-Public/helm-orb) [![CircleCI Orb Version](https://img.shields.io/badge/endpoint.svg?url=https://badges.circleci.io/orb/circleci/helm)](https://circleci.com/orbs/registry/orb/circleci/helm) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/CircleCI-Public/helm-orb/blob/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs) | ||
# helm Orb [![CircleCI status](https://circleci.com/gh/CircleCI-Public/helm-orb.svg "CircleCI status")](https://circleci.com/gh/CircleCI-Public/helm-orb) [![CircleCI Orb Version](https://img.shields.io/badge/endpoint.svg?url=https://badges.circleci.io/orb/circleci/helm)](https://circleci.com/developer/orbs/orb/circleci/helm) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/CircleCI-Public/helm-orb/blob/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs) | ||
|
||
A CircleCI Orb to simplify deployments to Kubernetes using Helm. | ||
|
||
Here are the features that the Helm orb provides: | ||
|
||
- Installing the helm client (`install-helm-client`) | ||
- Installing helm on a cluster (`install-helm-on-cluster`) | ||
- Installing helm charts (`install-helm-chart`) and deleting releases (`delete-helm-release`) | ||
|
||
Table of Contents | ||
|
@@ -17,83 +16,15 @@ Table of Contents | |
|
||
## Usage | ||
|
||
See the [orb registry listing](http://circleci.com/orbs/registry/orb/circleci/helm) for usage guidelines. | ||
See the [orb registry listing](https://circleci.com/developer/orbs/orb/circleci/helm) for usage guidelines. | ||
|
||
## Requirements | ||
|
||
- `curl` should be present in `PATH`. | ||
|
||
## Examples | ||
|
||
``` | ||
version: 2.1 | ||
orbs: | ||
aws-eks: circleci/[email protected] | ||
helm: circleci/[email protected] | ||
jobs: | ||
install-helm-on-cluster: | ||
executor: aws-eks/python | ||
parameters: | ||
cluster-name: | ||
type: string | ||
description: Cluster name | ||
steps: | ||
- aws-eks/update-kubeconfig-with-authenticator: | ||
cluster-name: << parameters.cluster-name >> | ||
install-kubectl: true | ||
- helm/install-helm-on-cluster: | ||
enable-cluster-wide-admin-access: true | ||
install-helm-chart: | ||
executor: aws-eks/python | ||
parameters: | ||
cluster-name: | ||
type: string | ||
description: Cluster name | ||
steps: | ||
- aws-eks/update-kubeconfig-with-authenticator: | ||
cluster-name: << parameters.cluster-name >> | ||
- helm/install-helm-chart: | ||
chart: stable/grafana | ||
release-name: grafana-release | ||
delete-helm-release: | ||
executor: aws-eks/python | ||
parameters: | ||
cluster-name: | ||
type: string | ||
description: Cluster name | ||
steps: | ||
- aws-eks/update-kubeconfig-with-authenticator: | ||
cluster-name: << parameters.cluster-name >> | ||
- helm/delete-helm-release: | ||
release-name: grafana-release | ||
purge: true | ||
timeout: 600 | ||
workflows: | ||
deployment: | ||
jobs: | ||
- aws-eks/create-cluster: | ||
cluster-name: test-cluster | ||
- install-helm-on-cluster: | ||
cluster-name: test-cluster | ||
requires: | ||
- aws-eks/create-cluster | ||
- install-helm-chart: | ||
cluster-name: test-cluster | ||
requires: | ||
- install-helm-on-cluster | ||
- delete-helm-release: | ||
cluster-name: test-cluster | ||
requires: | ||
- install-helm-chart | ||
- aws-eks/delete-cluster: | ||
cluster-name: test-cluster | ||
wait: true | ||
requires: | ||
- delete-helm-release | ||
``` | ||
Refer to the usage examples [here](https://circleci.com/developer/orbs/orb/circleci/helm#usage-install-helm-chart-with-helm3). | ||
|
||
## Contributing | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters