Back to Charts

Voyager

stable/voyager/README.md

latest5.1 KB
Original Source

This chart is DEPRECATED and moved to https://github.com/appscode/charts

Voyager

Voyager by AppsCode - Secure Ingress Controller for Kubernetes

TL;DR;

console
$ helm install stable/voyager

Introduction

This chart bootstraps an ingress controller deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

  • Kubernetes 1.8+

Installing the Chart

To install the chart with the release name my-release:

console
$ helm install --name my-release stable/voyager

The command deploys Voyager Controller on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release:

console
$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the Voyager chart and their default values.

ParameterDescriptionDefault
dockerRegistryDocker registry used to pull Voyager related imagesappscode
imageTags.voyagerTag of Voyager operator image6.0.0
imageTags.haproxyTag of HAProxy container image1.7.10-6.0.0
imagePullSecretsSpecify image pull secretsnil (does not add image pull secrets to deployed pods)
imagePullPolicyImage pull policyIfNotPresent
cloudProviderName of cloud providernil
cloudConfigPath to cloud config``
criticalAddonIf true, installs Voyager operator as critical addonfalse
logLevelLog level for operator3
persistence.enabledEnable mounting cloud configfalse
persistence.hostPathHost mount path for cloud config/etc/kubernetes
nodeSelectorNode labels for pod assignment{}
rbac.createIf true, create and use RBAC resourcestrue
serviceAccount.createIf true, create a new service accounttrue
serviceAccount.nameService account to be used. If not set and serviceAccount.create is true, a name is generated using the fullname template``
ingressClassIngress class to watch for. If empty, it handles all ingress``
apiserver.groupPriorityMinimumThe minimum priority the group should have.10000
apiserver.versionPriorityThe ordering of this API inside of the group.15
apiserver.enableAdmissionWebhookConfigure apiserver as admission webhooks for Voyager CRDsfalse
apiserver.caCA certificate used by main Kubernetes api server``

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example:

console
$ helm install --name my-release --set image.tag=v0.2.1 stable/voyager

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example:

console
$ helm install --name my-release --values values.yaml stable/voyager

RBAC

By default the chart will not install the recommended RBAC roles and rolebindings.

You need to have the flag --authorization-mode=RBAC on the api server. See the following document for how to enable RBAC.

To determine if your cluster supports RBAC, run the following command:

console
$ kubectl api-versions | grep rbac

If the output contains "beta", you may install the chart with RBAC enabled (see below).

Enable RBAC role/rolebinding creation

To enable the creation of RBAC resources (On clusters with RBAC). Do the following:

console
$ helm install --name my-release stable/voyager --set rbac.create=true