awslabs / aws-servicebroker

AWS Service Broker
Apache License 2.0
468 stars 132 forks source link

[Doc bug] There is no obvious documentation of the helm chart #185

Open iMartyn opened 4 years ago

iMartyn commented 4 years ago

Describe the bug The getting started k8s tells you where to install the chart from, and it states you should "Add flags to set credentials, region, etc" but there is no documentation saying what values to change to do this.

To Reproduce Attempt to set up aws-servicebroker on a non-aws k8s cluster (e.g. GKE or minikube etc) by following the getting started guide.

Expected behavior Some kind of documentation on how to configure the helm chart. e.g. https://hub.helm.sh/charts/stable/cluster-autoscaler gives a lot, but even just replicating the Configuration section would be enough to get up and running.

Screenshots https://github.com/awslabs/aws-servicebroker/blob/a3febc709e7f51ced48c244bbb96efa7cbc9e2cb/docs/getting-started-k8s.md

Environment (please complete the following information):

Additional context I can perhaps download the chart and try and figure out values that way but really, there should be a page describing the values, their defaults and what they do.

iMartyn commented 4 years ago

In case anyone wants to know the basic details, helm show values awssb/aws-servicebroker yeilds :

image: awsservicebroker/aws-servicebroker:beta
imagePullPolicy: Always
authenticate: true
tls:
  cert:
  key:
deployClusterServiceBroker: true
deployNamespacedServiceBroker: false
aws:
  region: us-east-1
  bucket: awsservicebroker
  key: templates/latest
  s3region: us-east-1
  tablename: awssb
  accesskeyid: ""
  secretkey: ""
  targetaccountid: ""
  targetrolename: ""
  vpcid: ""
brokerconfig:
  verbosity: 10
  brokerid: awsservicebroker
  prescribeoverrides: true
annotations: {}
clusterDomain: cluster.local

So that gives a very rough idea of how to set the values, but doesn't indicate what is optional/required or any real clue as to what the values should be in your setup.