Add documentation for Helm deployment #875

sdake · 2018-01-18T18:46:46Z

This adds documentation along with related configuration options for
deploying Istio with the Helm charts.

sdake · 2018-01-18T18:47:51Z

@sbezverk would you mind reviewing. There are a couple spots where the documentation has NEEDS REVIEW which could use a one liner description.

linsun · 2018-01-18T21:19:59Z

_docs/setup/kubernetes/helm.md

@@ -0,0 +1,76 @@
+---
+title: Alpha Quality Helm Chart


we don't normally put Alpha in doc... the status should be tracked in feature stage doc to be consistent

linsun · 2018-01-18T21:20:37Z

_docs/setup/kubernetes/helm.md

+1. Create the Helm chart:
+  ```bash
+  helm install install/kuberentes/istio --name istio
+  ```


typo on kubernetes?

nope, still kuberenetes

linsun · 2018-01-18T21:20:56Z

_docs/setup/kubernetes/helm.md

+## Prerequisites
+
+The following instructions require you have access to Helm **2.7.2 or newer** in your Kubernetes environment or 
+alternately the ability to modify RBAC rules required to install Helm.


Let us refer to k8s version in the setup doc too.

linsun · 2018-01-18T21:21:30Z

_docs/setup/kubernetes/helm.md

+| istio.ca_demo               | true/false         | false                      | NEEDS REVIEW                                 |
+| istio.ingress.use_nodeport  | true/false         | false                      | Specifies whether to use nodeport or LB      |
+| istio.ingress.nodeport_port | 1024 to 65535      | 32000                      | If nodeport is used, specifies its port      |
+


could you update this? This was changed yesterday to simplify things.

updated. Agree much simpler.

linsun

Thank you for working on document this, please see some minor comments I put in.

sdake · 2018-01-19T00:27:21Z

@linsun Thanks for the review. I'm sort of consumed today and tomorrow. Will produce the requested changes Monday. By feature tracking, do you mean this document? https://docs.google.com/spreadsheets/d/1mUIrX82Z8mRuhNWyl5D_sd_Evg3KzeNotzRorPzQMko/edit?ts=5a03f88d#gid=351491887

Cheers
-steve

ldemailly · 2018-01-19T01:33:28Z

I believe lin meant https://istio.io/about/feature-stages.html

sdake · 2018-01-19T01:35:36Z

@ldemailly thanks - will address that in the next rev.

ldemailly · 2018-01-19T01:45:55Z

that page itself being quite sensitive - I would just focus on getting working helm instructions and not so much about alpha status or updating the feature stage in this PR - that can be later I think

linsun · 2018-01-19T02:27:02Z

Thank you @sdake and @ldemailly ! The plan sounds good.

sdake · 2018-01-23T10:27:13Z

This patch should be good to go. I am aware of istio/istio#2734, however, I had committed to @costinm to have these documentation changes in around the release of 0.4.0 (~3 weeks ago). With all of the refactoring related to Helm, it was difficult to find a good point at which to merge these changes. I think the above PR will take some time to sort out and will commit to revising this documentation when istio/istio#2734 merges.

Cheers
-steve

sdake · 2018-01-23T18:33:01Z

@linsun would you mind merging this?

Cheers
-steve

ldemailly · 2018-01-23T19:33:01Z

_docs/setup/kubernetes/helm.md

+title: Istio Helm Chart Instructions
+overview: Instructions for the setup and configuration of Istio using the Helm package manager.
+
+order: 10


order should not be the same as quickstart

can you attach a preview of the toc/nav once fixed

good catch! Taught me something new.

linsun · 2018-01-23T19:42:00Z

_docs/setup/kubernetes/helm.md

+| global.pilot.tag             | image tag          | release unique hash        | Specifies the TAG for the pilot image          |
+| global.pilot.enabled         | true/false         | true                       | Specifies whether pilot is enabled/disabled     |
+| istio.ca.hub                 | registry+namespace | release registry/namespace | Specifies the HUB for the ca image             |
+| istio.ca.tag                 | image tag          | release unique hash        | Specifies the TAG for the ca image             |


do we still have these two helm vars? think they are renamed to global.security.hub and tag.

Good catch.

linsun

Thanks for making the changes. Approve pending address the comments.

sdake · 2018-01-23T19:43:56Z

@linsun @ldemailly thanks for the quick reviews. I'll take a look today and push an update on security (if that has changed) and attach a nav page this evening.

Cheers
-steve

linsun · 2018-01-23T19:44:54Z

@ldemailly is there a place we can download a daily build? would be nice to validate the packaging is good in a pre-0.5 build.

ldemailly · 2018-01-23T20:03:24Z

@linsun yes http://gcsweb.istio.io/gcs/istio-prerelease/daily-build/

that one may not yet have istioctl fixed, so I asked the team to kick a new daily

you need to use the TEST tgz

sdake · 2018-01-24T01:25:25Z

Navigation page attached:

sdake · 2018-01-24T14:08:45Z

I noticed one small error after testing the instructions after rendering them (thanks @ldemailly for the hint :). I'll push an additional patch to fix that problem @6pm PST today. Please don't merge until a 1 liner update comes.

Cheers
-steve

ldemailly · 2018-01-25T05:04:35Z

_docs/setup/kubernetes/helm.md

+
+1. Create the Helm chart:
+  ```bash
+  helm install install/kuberenetes/helm/istio --name istio


ping ^ kuberenetes
can you try the command line too / does it work :-)

A sign I need to go to bed :-) - I have run this workflow about 10-15 times in the last 2 days, however, I was manually typing and using completion. I'll make the typo change, render the docs, and C&P the docs into a log - in the morning :) Thanks for the patience.

you can use the "copy" button from the rendered version and paste in terminal to be sure it's the right command :-)

thx !

yup - my 10-15 runs were for training purposes - so a CP isn't ideal in that model.

sdake · 2018-01-25T17:50:07Z

Looks like istio/istio#2734 merged sooner than I expected. I will need to change the table in this document considerably, so will need a bit more time on the docs. Should be able to wrap them up today however.

Cheers
-steve

sdake · 2018-01-30T05:29:01Z

This review is blocked on sorting out the Helm charts for the 0.5.0 release. I'll ping reviewers when it has been updated to match the new canonical version.

sdake · 2018-01-30T05:30:28Z

/hold

This adds documentation along with related configuration options for deploying Istio with the Helm charts.

Fix a typo in the install command and warning clause about automatic sidecar injection not being implemented.

sdake · 2018-02-05T18:47:56Z

@linsun My plan here is to merge these as is (since these instructions render properly and work today) and follow up with an update to the table as a separate patch. Could you merge, and I'll start working on the updated table contents as well as integrating the README.md in the istio repository related to Helm?

Cheers
-steve

sdake mentioned this pull request Jan 18, 2018

Helm installation method needs documentation istio/istio#2630

Closed

linsun reviewed Jan 18, 2018

View reviewed changes

linsun requested changes Jan 18, 2018

View reviewed changes

sdake force-pushed the helm_docs branch 3 times, most recently from dd14d06 to 6bab1f2 Compare January 23, 2018 10:23

ldemailly reviewed Jan 23, 2018

View reviewed changes

linsun reviewed Jan 23, 2018

View reviewed changes

linsun approved these changes Jan 23, 2018

View reviewed changes

ldemailly reviewed Jan 25, 2018

View reviewed changes

sdake mentioned this pull request Jan 25, 2018

Refactor helm charts istio/istio#2734

Merged

6 tasks

This was referenced Jan 30, 2018

missing usage docs for istioctl gen-deploy istio/istio#2927

Closed

How to install istio 0.4 ingress controller and addons with Helm Chart? istio/istio#2994

Closed

Steven Dake added 4 commits February 5, 2018 11:35

Add documentation for Helm deployment

e2faecb

This adds documentation along with related configuration options for deploying Istio with the Helm charts.

Few corrections as suggested during review.

db86291

Fix error in path to install Helm package

d904368

Slight refinement of helm documentation

268b72e

Fix a typo in the install command and warning clause about automatic sidecar injection not being implemented.

sdake force-pushed the helm_docs branch from 1c45893 to 268b72e Compare February 5, 2018 18:44

linsun merged commit f9e5df3 into istio:master Feb 5, 2018

sdake deleted the helm_docs branch February 5, 2018 18:52

Add documentation for Helm deployment #875

Add documentation for Helm deployment #875

Conversation

sdake commented Jan 18, 2018

sdake commented Jan 18, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linsun left a comment

Choose a reason for hiding this comment

sdake commented Jan 19, 2018

ldemailly commented Jan 19, 2018

sdake commented Jan 19, 2018

ldemailly commented Jan 19, 2018 • edited Loading

linsun commented Jan 19, 2018

sdake commented Jan 23, 2018

sdake commented Jan 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linsun left a comment

Choose a reason for hiding this comment

sdake commented Jan 23, 2018

linsun commented Jan 23, 2018

ldemailly commented Jan 23, 2018 • edited Loading

sdake commented Jan 24, 2018

sdake commented Jan 24, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sdake commented Jan 25, 2018

sdake commented Jan 30, 2018

sdake commented Jan 30, 2018

sdake commented Feb 5, 2018

ldemailly commented Jan 19, 2018 •

edited

Loading

ldemailly commented Jan 23, 2018 •

edited

Loading