istio.io icon indicating copy to clipboard operation
istio.io copied to clipboard

Document use of ambient wrapper chart in 1.23 install/upgrade guides

Open bleggett opened this issue 1 year ago • 3 comments

Description

Fixes https://github.com/istio/istio.io/issues/15167

Note that until at least a 1.23 prerelease build is published, the ambient chart will not show up in the documented repo, see https://github.com/istio/release-builder/pull/1849

To test locally in the meantime, you can use the local copies of the chart, so instead of doing:

helm install istio-ambient istio/ambient -n istio-system --create-namespace --wait

like the doc says, do

helm install ambient ./manifests/charts/ambient -n istio-system --create-namespace --wait

(you may need to run helm dep update ./manifests/charts/ambient first to populate the depcache)

I left both the individual and wrapper modes in both docs.

Reviewers

  • [x] Ambient
  • [x] Docs
  • [x] Installation
  • [ ] Networking
  • [ ] Performance and Scalability
  • [ ] Extensions and Telemetry
  • [ ] Security
  • [ ] Test and Release
  • [ ] User Experience
  • [ ] Developer Infrastructure
  • [ ] Localization/Translation

bleggett avatar Jun 13 '24 20:06 bleggett

/test gencheck

bleggett avatar Jun 17 '24 23:06 bleggett

/test doc.test.profile-default

bleggett avatar Jun 18 '24 21:06 bleggett

/cc @costinm for opinions per comment

craigbox avatar Jul 02 '24 22:07 craigbox

/retest-required

craigbox avatar Jul 02 '24 22:07 craigbox

Do we want to have this in get started guide as the wrapper chart is mainly to show how simple it is to install Istio for demo purpose?

Just to recap some discussion from Monday's TOC, unfortunately the attendance is relative low, but folks on the call @therealmitchconnors @keithmattix @howardjohn and myself prefer to have the simple 1 helm install for demo purpose (or consider using helmfile as an alternative if we choose not to publish the wrapper chart). One primary concern is not to show people multiple ways to do Install within 1 install method (which is helm here) and the existing helm install instructions offer more flexibility than the wrapper chart. Please correct me if I am wrong here in capturing the discussion.

linsun avatar Jul 10 '24 13:07 linsun

Do we want to have this in get started guide as the wrapper chart is mainly to show how simple it is to install Istio for demo purpose?

:+1: I'll make that change, it makes sense.

bleggett avatar Jul 10 '24 18:07 bleggett

The other key part of the TOC discussion was to move this chart wrapper under samples/. We can still publish to OCI (and probably should!), but under "samples" in some way (could be gcr.io/istio-release/samples/...)

howardjohn avatar Jul 11 '24 12:07 howardjohn

The other key part of the TOC discussion was to move this chart wrapper under samples/. We can still publish to OCI (and probably should!), but under "samples" in some way (could be gcr.io/istio-release/samples/...)

:+1: I assume that's release-builder changes, will do.

bleggett avatar Jul 11 '24 21:07 bleggett

@linsun @craigbox et al - PTAL:

  • Moved the simple Helm instructions to gettting started
  • Left the full Helm instructions in helm install

tweaked wording and such.

Chart move PR: https://github.com/istio/istio/pull/52013

Chart publish under "samples" PR: https://github.com/istio/release-builder/pull/1901

bleggett avatar Jul 15 '24 23:07 bleggett

@bleggett: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
doc.test.profile-ambient_istio.io 8f6c1a62faccf56e58ff0deff63708e09d612fd0 link true /test doc.test.profile-ambient

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

istio-testing avatar Jul 25 '24 17:07 istio-testing

Test failure is because the extend-wasm guide uses the Gateway API install docs from the getting started page, which were removed when we went to Helm.

craigbox avatar Jul 29 '24 04:07 craigbox

Test failure is because the extend-wasm guide uses the Gateway API install docs from the getting started page, which were removed when we went to Helm.

Yeah I fixed some of this in https://github.com/istio/istio.io/pull/15474 - that one should probably go in before this one, and I'll resync this one pending the outcome of https://github.com/istio/istio.io/pull/15279#discussion_r1695641694

bleggett avatar Jul 29 '24 17:07 bleggett

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

istio-testing avatar Jul 30 '24 22:07 istio-testing

FYI, I added this PR to ambient meeting agenda for tmr.

linsun avatar Jul 31 '24 02:07 linsun

Aight so current consensus: https://docs.google.com/document/d/1SMlwliEnthgq7r2PjpLl1kCq3t8rAMbgu6r_lDAXJ0w/edit#heading=h.ttmnrtyxr98j

  • we aren't going to document the wrapper chart (gonna close this PR)
  • The wrapper chart is published under samples: https://github.com/istio/release-builder/pull/1901 but I am not comfortable publishing an artifact we do not document or doctest (which is why this PR was opened) - for now there seems to be a desire to leave it published but not document or doctest it, so I will leave it.

bleggett avatar Jul 31 '24 18:07 bleggett