Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update outdated installation docs #26430

Closed
18 tasks done
michi-covalent opened this issue Jun 22, 2023 · 7 comments
Closed
18 tasks done

update outdated installation docs #26430

michi-covalent opened this issue Jun 22, 2023 · 7 comments
Assignees
@michi-covalent
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-blocker/1.14 This issue will prevent the release of the next version of Cilium.

Comments

@michi-covalent
Copy link
Contributor

michi-covalent commented Jun 22, 2023 •
edited

let's use this issue to track outdated documentation pages so that we can update them for v1.14 release ✨

anything else?

additional pages to check

  • Documentation/gettingstarted/hubble.rst
  • Documentation/gettingstarted/k8s-install-default.rst
  • Documentation/helm-values.rst
  • Documentation/installation/k3s.rst
  • Documentation/installation/k8s-install-migration.rst
  • Documentation/network/clustermesh/aks-clustermesh-prep.rst
  • Documentation/network/clustermesh/clustermesh.rst
  • Documentation/network/external-workloads.rst
  • Documentation/network/servicemesh/gateway-api/installation.rst
  • Documentation/network/servicemesh/installation.rst
  • Documentation/network/servicemesh/tls-default-certificate.rst
  • Documentation/operations/performance/tuning.rst
  • Documentation/security/network/encryption-ipsec.rst
  • Documentation/security/network/encryption-wireguard.rst
@michi-covalent michi-covalent added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-blocker/1.14 This issue will prevent the release of the next version of Cilium. labels Jun 22, 2023
@asauber
Copy link
Member

asauber commented Jun 23, 2023 •
edited

Regarding cilium-cli, I do think that 0.15 should be the release marked as "maintained" for the 1.14 release, and that it should have Helm mode as the default. I have this issue assigned to myself track that. I'll add a task for the initial pass to update existing cilium-cli references. I should be able to complete that within the next week or so.

@tklauser
Copy link
Member

I agree that 0.15 should default to helm mode and be the supported cilium-cli release for Cilium v1.14.

otherwise we need to support the classic mode for another 6 months

I think worst case we'd even have to support it until 1.14 is EoL which is when v1.16 releases - so 18 months. All the more reason to default to helm mode now.

@tklauser tklauser changed the title update oudated docs update outdated installation docs Jun 23, 2023
michi-covalent added a commit that referenced this issue Jun 23, 2023
@michi-covalent
docs: Fix the cilium-cli default branch name
be5847e 
The default branch name for cilium/cilium-cli repo changed from master
to main. The current instructions still work because the master branch
gets synched with the main branch, but let's update the docs to use the
new default branch name to avoid any confusion in the future.

Ref: #26430
Ref: https://github.com/cilium/cilium-cli/blob/main/.github/workflows/mirror.yaml

Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
@michi-covalent michi-covalent mentioned this issue Jun 23, 2023
Merged
michi-covalent added a commit that referenced this issue Jun 23, 2023
@michi-covalent
v1.13 docs: Use stable-v0.14.txt for cilium-cli version
5944225 
The next cilium-cli release is v0.15.0 with Helm mode as the default
installation mode. Continue to use v0.14 cilium-cli for v1.13 docs since
we haven't validated v1.13 docs using Helm mode.

Also change the branch name from master to main. The default branch name
recently changed from master to main in cilium-cli repo.

Ref: cilium/cilium-cli#1759
Ref: #26430

Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
michi-covalent added a commit that referenced this issue Jun 23, 2023
@michi-covalent
v1.12 docs: Use stable-v0.14.txt for cilium-cli version
9415085 
The next cilium-cli release is v0.15.0 with Helm mode as the default
installation mode. Continue to use v0.14 cilium-cli for v1.12 docs since
we haven't validated v1.12 docs using Helm mode.

Also change the branch name from master to main. The default branch name
recently changed from master to main in cilium-cli repo.

Ref: cilium/cilium-cli#1759
Ref: #26430

Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
michi-covalent added a commit that referenced this issue Jun 23, 2023
@michi-covalent
v1.11 docs: Use stable-v0.14.txt for cilium-cli version
c12aed8 
The next cilium-cli release is v0.15.0 with Helm mode as the default
installation mode. Continue to use v0.14 cilium-cli for v1.11 docs since
we haven't validated v1.11 docs using Helm mode.

Also change the branch name from master to main. The default branch name
recently changed from master to main in cilium-cli repo.

Ref: cilium/cilium-cli#1759
Ref: #26430

Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
This was referenced Jun 23, 2023
Merged
Merged
Merged
michi-covalent added a commit that referenced this issue Jun 23, 2023
@michi-covalent
docs: Fix the cilium-cli default branch name
e7126f7 
The default branch name for cilium/cilium-cli repo changed from master
to main. The current instructions still work because the master branch
gets synched with the main branch, but let's update the docs to use the
new default branch name to avoid any confusion in the future.

Ref: #26430
Ref: https://github.com/cilium/cilium-cli/blob/main/.github/workflows/mirror.yaml

Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
michi-covalent added a commit that referenced this issue Jun 23, 2023
@michi-covalent
v1.13 docs: Use stable-v0.14.txt for cilium-cli version
4cb719b 
The next cilium-cli release is v0.15.0 with Helm mode as the default
installation mode. Continue to use v0.14 cilium-cli for v1.13 docs since
we haven't validated v1.13 docs using Helm mode.

Also change the branch name from master to main. The default branch name
recently changed from master to main in cilium-cli repo.

Ref: cilium/cilium-cli#1759
Ref: #26430

Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
michi-covalent added a commit that referenced this issue Jun 23, 2023
@michi-covalent
v1.12 docs: Use stable-v0.14.txt for cilium-cli version
bc1b881 
The next cilium-cli release is v0.15.0 with Helm mode as the default
installation mode. Continue to use v0.14 cilium-cli for v1.12 docs since
we haven't validated v1.12 docs using Helm mode.

Also change the branch name from master to main. The default branch name
recently changed from master to main in cilium-cli repo.

Ref: cilium/cilium-cli#1759
Ref: #26430

Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
michi-covalent added a commit that referenced this issue Jun 23, 2023
@michi-covalent
v1.11 docs: Use stable-v0.14.txt for cilium-cli version
ed26f99 
The next cilium-cli release is v0.15.0 with Helm mode as the default
installation mode. Continue to use v0.14 cilium-cli for v1.11 docs since
we haven't validated v1.11 docs using Helm mode.

Also change the branch name from master to main. The default branch name
recently changed from master to main in cilium-cli repo.

Ref: cilium/cilium-cli#1759
Ref: #26430

Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
@danehans
Copy link
Contributor

xref #26531 to update the k8s requirements doc.

michi-covalent added a commit that referenced this issue Jul 3, 2023
@michi-covalent
docs: Update the docs for Helm mode Cilium CLI
95427f9 
- Consistently use the --set flag.
- Replace --helm-auto-gen-values with --dry-run-helm-values.
- Set kubeProxyReplacement to "true" instead of "strict".

Ref: #26430

Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
@michi-covalent michi-covalent mentioned this issue Jul 3, 2023
Merged
@nvibert
Copy link
Contributor

nvibert commented Jul 6, 2023

We're seeing some reported issues from folks using Cilium CLI to install with --azure-resource-group as this is no longer supported in the new Azure CLI mode.

michi-covalent added a commit that referenced this issue Jul 6, 2023
@michi-covalent @giorio94 @learnitall
docs: Update the docs for Helm mode Cilium CLI
a26e2f8 
- Consistently use the --set flag.
- Replace --helm-auto-gen-values with --dry-run-helm-values.
- Set kubeProxyReplacement to "true" instead of "strict".
- Add a section in the upgrade guide.
- Add a warning in cilium-cli installation instructions to highlight
  that you need to upgrade cilium-cli to v0.15.0 or later.

Ref: #26430

Co-authored-by: Marco Iorio <marco.iorio@isovalent.com>
Co-authored-by: Ryan Drew <ryan.drew@isovalent.com>
Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
@joestringer
Copy link
Member

IMO flags like --azure-resource-group should be retained in cilium-CLI and mapped into the Helm value in the new helm mode.

@michi-covalent
Copy link
Contributor Author

you mean retain them so that we can deprecate them first and remove them later, or retain them and support them in the long term?

if the latter, i'm open to discussion in terms of what installation flags cilium-cli should provide. i think we need clear guidelines in terms of what types of settings should have a dedicated CLI flag vs Helm values 🎏

borkmann pushed a commit that referenced this issue Jul 7, 2023
@michi-covalent @giorio94
@learnitall @borkmann
docs: Update the docs for Helm mode Cilium CLI
ba52226 
- Consistently use the --set flag.
- Replace --helm-auto-gen-values with --dry-run-helm-values.
- Set kubeProxyReplacement to "true" instead of "strict".
- Add a section in the upgrade guide.
- Add a warning in cilium-cli installation instructions to highlight
  that you need to upgrade cilium-cli to v0.15.0 or later.

Ref: #26430

Co-authored-by: Marco Iorio <marco.iorio@isovalent.com>
Co-authored-by: Ryan Drew <ryan.drew@isovalent.com>
Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
@michi-covalent
Copy link
Contributor Author

i'll open a separate cilium-cli issue for improving the overall UX friendliness 🎏🎏🎏. closing this issue as completed ✅

jibi pushed a commit that referenced this issue Jul 10, 2023
@michi-covalent @giorio94
@learnitall @jibi
docs: Update the docs for Helm mode Cilium CLI
5f95ecf 
[ upstream commit ba52226 ]

- Consistently use the --set flag.
- Replace --helm-auto-gen-values with --dry-run-helm-values.
- Set kubeProxyReplacement to "true" instead of "strict".
- Add a section in the upgrade guide.
- Add a warning in cilium-cli installation instructions to highlight
  that you need to upgrade cilium-cli to v0.15.0 or later.

Ref: #26430

Co-authored-by: Marco Iorio <marco.iorio@isovalent.com>
Co-authored-by: Ryan Drew <ryan.drew@isovalent.com>
Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
Signed-off-by: Gilberto Bertin <jibi@cilium.io>
julianwiedmann pushed a commit that referenced this issue Jul 11, 2023
@michi-covalent @giorio94
@learnitall @julianwiedmann
docs: Update the docs for Helm mode Cilium CLI
4a475aa 
[ upstream commit ba52226 ]

- Consistently use the --set flag.
- Replace --helm-auto-gen-values with --dry-run-helm-values.
- Set kubeProxyReplacement to "true" instead of "strict".
- Add a section in the upgrade guide.
- Add a warning in cilium-cli installation instructions to highlight
  that you need to upgrade cilium-cli to v0.15.0 or later.

Ref: #26430

Co-authored-by: Marco Iorio <marco.iorio@isovalent.com>
Co-authored-by: Ryan Drew <ryan.drew@isovalent.com>
Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
Signed-off-by: Gilberto Bertin <jibi@cilium.io>
ldelossa pushed a commit to ldelossa/cilium that referenced this issue Sep 27, 2023
@michi-covalent @giorio94
@learnitall @jibi
docs: Update the docs for Helm mode Cilium CLI
71eaf21 
[ upstream commit ba52226 ]

- Consistently use the --set flag.
- Replace --helm-auto-gen-values with --dry-run-helm-values.
- Set kubeProxyReplacement to "true" instead of "strict".
- Add a section in the upgrade guide.
- Add a warning in cilium-cli installation instructions to highlight
  that you need to upgrade cilium-cli to v0.15.0 or later.

Ref: cilium#26430

Co-authored-by: Marco Iorio <marco.iorio@isovalent.com>
Co-authored-by: Ryan Drew <ryan.drew@isovalent.com>
Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
Signed-off-by: Gilberto Bertin <jibi@cilium.io>
pchaigno pushed a commit that referenced this issue Jan 8, 2024
@michi-covalent @tklauser
v1.13 docs: Use stable-v0.14.txt for cilium-cli version
a2f0d06 
The next cilium-cli release is v0.15.0 with Helm mode as the default
installation mode. Continue to use v0.14 cilium-cli for v1.13 docs since
we haven't validated v1.13 docs using Helm mode.

Also change the branch name from master to main. The default branch name
recently changed from master to main in cilium-cli repo.

Ref: cilium/cilium-cli#1759
Ref: #26430

Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
Signed-off-by: Tobias Klauser <tobias@isovalent.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@michi-covalent michi-covalent

Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-blocker/1.14 This issue will prevent the release of the next version of Cilium.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@tklauser @joestringer @danehans @asauber @michi-covalent @nvibert