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.

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

attempt to remove plugin from docs #1219

Merged
merged 32 commits into from
Jun 7, 2024
Merged

attempt to remove plugin from docs #1219

merged 32 commits into from
Jun 7, 2024

Conversation

feorlen
Copy link
Collaborator

@feorlen feorlen commented May 16, 2024

The Kubernetes plugin is gone, this PR replaces the procedures that use kubectl minio in all its various forms. The plugin was referenced on many pages and for many purposes so there is a lot of restructuring involved.

Some procedures no longer have CLI instructions, which can be addressed in subsequent PRs. Everything should have at least one working method, even if it's to use Operator Console.

  • Remove references to plugin, except for pre-4.5.8 upgrade paths
  • Move pre-4.5.8 upgrade paths to new child page (currently hidden from TOC, linked in page)
  • Fill in with new Kustomize, kubectl, and/or Operator Console steps.

A handful of old screen captures still to be updated

Staged:

Fixes #1213

@feorlen feorlen marked this pull request as draft May 16, 2024 21:03
@feorlen feorlen marked this pull request as ready for review June 3, 2024 23:40
Copy link
Collaborator

@ravindk89 ravindk89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent first pass. Mostly tidy-ups.

source/includes/k8s/deploy-operator.rst Show resolved Hide resolved
@@ -51,5 +48,5 @@ For guidance on connecting ``kubectl`` to AKS, see :aks-docs:`Install kubectl an
Procedure
---------

.. include:: /includes/common/common-install-operator-kubectl-plugin.rst
Something Kustomize
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hah.

FWIW the procedure should be exactly identical no matter what. EKS, AKS, and GKS should treat kubectl apply -k github.com/minio/operator identically.

I can also handle this as part of the deplatformization if we want, but if we go that route we have to push this to an independent branch before we go to main

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Trying something - same text from k8s (conveniently already an include) as the "Procedure" section for aks, eks, gke.

I'm not entirely sure the console port forwarding instructions are accurate for not-k8s. Also the admonition about only using Kustomize going forward. I could also copy the include content, minus those bits, into the three other pages.

Or is it close enough, given it's all getting yeeted shortly anyway.

Thoughts? @ravindk89 @djwfyi

staged:
aks:
http://192.241.195.202:9000/staging/DOCS-1213-upstream/aks/operations/installation.html#procedure

eks:
http://192.241.195.202:9000/staging/DOCS-1213-upstream/eks/operations/installation.html#procedure

gke:
http://192.241.195.202:9000/staging/DOCS-1213-upstream/gke/operations/installation.html#procedure

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this is good enough.

djwfyi
djwfyi previously requested changes Jun 4, 2024
Copy link
Collaborator

@djwfyi djwfyi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, what a load of work. Thanks for taking this on.
A number of suggestions for your consideration.
I did not look at staging this pass, but will with the next one.

Copy link

@shtripat shtripat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly looks good. Check @djwfyi 's comments.

Copy link
Collaborator

@ravindk89 ravindk89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is good to go. We can make further clean ups in the IA rewrite pull as needed.

Excellent work.

@feorlen feorlen dismissed djwfyi’s stale review June 7, 2024 15:05

comments addressed with changes and other approvals. Thanks @djwfyi !

@feorlen feorlen merged commit d17c896 into main Jun 7, 2024
@feorlen feorlen deleted the DOCS-1213-upstream branch June 7, 2024 15:05
feorlen added a commit that referenced this pull request Jun 7, 2024
Fix build warnings from #1219 

Some are broken refs that need to point elsewhere.

Some are because `openshift`, `eks`, `gke`, `aks` can't see a target
that's on a `k8s` page, apparently due to how
`operations/installation.rst` is structured. These we are still
investigating.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace Operator plugin deploy instructions with Kustomize
7 participants