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

Add helm installation steps for multi-cluster

Open nshankar13 opened this issue 1 year ago • 5 comments

Description

Adds Helm multi-cluster installation steps for all Istio multi-cluster control plane models and network topologies.

Preview link for quick reference: https://deploy-preview-15459--preliminary-istio.netlify.app/latest/docs/setup/install/multicluster/multi-primary/

Resolves: https://github.com/istio/istio.io/issues/14765

Tested against Istio 1.23.0-alpha.0 Helm charts.

Reviewers

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

nshankar13 avatar Jul 22 '24 15:07 nshankar13

😊 Welcome! This is either your first contribution to the Istio documentation repo, or it's been a while since you've been here. A few things you should know:

  • You can learn about how we write and maintain documentation, our style guidelines, and the available web site features by visiting Contributing to the Docs.

  • In the next few minutes, an automatic preview of your change will be built with a full copy of the istio.io website. You can find this preview by clicking on the Details link next to the deploy/netlify entry in the status section of this page.

  • We care about quality, so we've put in place a number of checks to ensure our documentation is top-notch. We do spell checking, sanitize the Markdown, ensure all hyperlinks point to a valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the lint_istio.io entry in the status section. Click on the Details link to get a list of the problems with your PR. Fix those problems and push an update; this will automatically re-run the tests. Hopefully this time everything will be perfect!

  • Once your changes are accepted and merged into the repository, they will initially show up on https://preliminary.istio.io. The changes will be published to https://istio.io the next time we do a major release (which typically happens every 3 months or so). To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

istio-policy-bot avatar Jul 22 '24 15:07 istio-policy-bot

Since you're updating snips here, make sure they get added to the testing.

dhawton avatar Jul 30 '24 22:07 dhawton

@dhawton any ideas on why the lint check is complaining about spelling here?

"Install Istio as primary in cluster1 using istioctl and the IstioOperator api"

nshankar13 avatar Jul 31 '24 21:07 nshankar13

@dhawton any ideas on why the lint check is complaining about spelling here?

"Install Istio as primary in cluster1 using istioctl and the IstioOperator api"

Running locally (make lint) is easier to identify. It's because it's API not api.

dhawton avatar Aug 01 '24 17:08 dhawton

/test doc.test.profile-default

nshankar13 avatar Aug 08 '24 01:08 nshankar13

/test doc.test.profile-demo

nshankar13 avatar Oct 23 '24 01:10 nshankar13

looking good @nshankar13 ! thanks for documenting this.

bleggett avatar Oct 25 '24 17:10 bleggett

@nshankar13: 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-default_istio.io 5d8922c link true /test doc.test.profile-default

This is a known flake https://github.com/istio/istio.io/issues/15505 btw - so the tests are looking good.

bleggett avatar Oct 25 '24 17:10 bleggett

/test doc.test.profile-default

bleggett avatar Oct 30 '24 16:10 bleggett

/retest

kfaseela avatar Oct 30 '24 20:10 kfaseela

@kfaseela @bleggett I think before merging this we need to wait on 1.24.0-rc.0 Helm chart to be published - even if we can get the go.mod Istio tag to point at most recent commit, the actual helm install step will use the most recent stable or rc chart. Ex - right now even though 1.24.0-alpha.0 is available I need to pin the version, because 1.23.2 still gets installed by default.

nshankar13 avatar Oct 30 '24 20:10 nshankar13

@nshankar13 I have added dnm label, feel free to remove it whenever this is ready for merge

kfaseela avatar Oct 30 '24 20:10 kfaseela

@kfaseela @bleggett I think before merging this we need to wait on 1.24.0-rc.0 Helm chart to be published - even if we can get the go.mod Istio tag to point at most recent commit, the actual helm install step will use the most recent stable or rc chart. Ex - right now even though 1.24.0-alpha.0 is available I need to pin the version, because 1.23.2 still gets installed by default.

Yep - I figured. Ideally I'd like it approved and DNM'd before tho so we can merge when the chart is published to make the CI happy.

bleggett avatar Oct 30 '24 20:10 bleggett

/retest

craigbox avatar Nov 08 '24 08:11 craigbox

@nshankar13 can you rebase this against master now that https://github.com/istio/istio.io/pull/15898 is in?

bleggett avatar Nov 08 '24 22:11 bleggett

/retest-required

nshankar13 avatar Nov 08 '24 23:11 nshankar13

/test doc.test.profile-default

nshankar13 avatar Nov 09 '24 00:11 nshankar13

/retest-required

craigbox avatar Nov 09 '24 02:11 craigbox

/test doc.test.profile-default

multicluster log says

Error: INSTALLATION FAILED: Unable to continue with install: CustomResourceDefinition "wasmplugins.extensions.istio.io" in namespace "" exists and cannot be imported into the current release: invalid ownership metadata; annotation validation error: missing key "meta.helm.sh/release-name": must be set to "istio-base"; annotation validation error: missing key "meta.helm.sh/release-namespace": must be set to "istio-system"

craigbox avatar Nov 09 '24 10:11 craigbox

/retest-required

Looking forward to seeing this over the line @nshankar13!

craigbox avatar Nov 17 '24 22:11 craigbox

@craigbox yes, will get to this sometime this week. Need to investigate that CI failure.

nshankar13 avatar Nov 17 '24 22:11 nshankar13

/test doc.test.profile-default

nshankar13 avatar Nov 20 '24 19:11 nshankar13

the flake is gone at least! Current error

craigbox avatar Nov 20 '24 22:11 craigbox

In response to a cherrypick label: #15459 failed to apply on top of branch "release-1.24":

Applying: Add helm installation steps for multi-primary
Applying: Update clusterid
Applying: Update config steps
Applying: Edit steps
Applying: Update multi-primary steps
Applying: Update files and docs
Applying: Add primary-remote steps
Applying: Edit spacing
Applying: Remove var
Applying: Fix cluster name
Applying: Update snips
Applying: Update docs
Applying: Update commands
Applying: Update docs
Applying: Update note
Applying: Resolve comments and UTs
Applying: Add quotes
Applying: Run make gen
Applying: Add more quotes
Applying: Fix lints
Applying: fix lint and spelling
Applying: Update tests
Applying: Add new tests for helm
Applying: Fix test
Applying: Update go.mod
Applying: Update installation scripts
Applying: Update helm repo setup scripts
Applying: Update cleanup steps
Applying: Update script and lint
Applying: update cleanup step
Applying: Update cleanup steps
Applying: Update cleanup steps
Applying: Fix cleanup script
Applying: Fix installation steps
Applying: Update scripts
Applying: Update istio-system ns creation steps
Applying: Fix CRD cleanup
Using index info to reconstruct a base tree...
M	go.mod
Falling back to patching base and 3-way merge...
Auto-merging go.mod
Applying: Update Helm CRD Cleanup
Using index info to reconstruct a base tree...
M	go.mod
Falling back to patching base and 3-way merge...
Auto-merging go.mod
Applying: Update cleanup
Applying: Remove additional var
Applying: Resolve comments
Using index info to reconstruct a base tree...
M	go.mod
Falling back to patching base and 3-way merge...
Auto-merging go.mod
Applying: fix go.mod
Using index info to reconstruct a base tree...
M	go.mod
Falling back to patching base and 3-way merge...
Auto-merging go.mod
Applying: Fix lint
Applying: update charts for remote profile
Applying: Update indentation
Applying: Update indentation
Applying: Fix lint
Applying: Fix numbering
Applying: Update installation steps
Applying: Add missing steps
Applying: Update cleanup steps
Applying: Fix indentation
Applying: Update indentation
Applying: Resolve comments
Applying: Resolve comments
Applying: update go.mod
Applying: remove cleanup
Applying: Update CRD cleanup
Applying: Update cleanup
Applying: Update cleanup
Using index info to reconstruct a base tree...
M	go.mod
Falling back to patching base and 3-way merge...
Auto-merging go.mod
CONFLICT (content): Merge conflict in go.mod
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0060 Update cleanup

istio-testing avatar Nov 23 '24 03:11 istio-testing

In response to a cherrypick label: new issue created for failed cherrypick: #15982

istio-testing avatar Nov 23 '24 03:11 istio-testing