Giters

IBM / cp4waiops-gitops

Manage Your IBM Cloud Pak for Watson AIOps With GitOps

Home Page:https://ibm.github.io/cp4waiops-gitops/docs/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Refine docs of gitops install for CP4WAIOps 3.4

morningspace opened this issue · comments

commented

Some changes may include:

  • To reflect the folder layout change
  • To indicate all-in-one template as experimental feature
commented

Some review comments for the GitOps install docs for 3.4 release:

  • podman login cp.icr.io --username cp --password "${IBM_ENTITLEMENT_KEY:?}" Let's indicate to reader that it's only applicable if you have installed podman or using OS such as RHEL with podman installed by default. Another option is using docker, of couse need install to docker CLI prior to that.
  • The "CP4WAIOps Advanced Install Options Using GitOps" link is broken.
  • "Install CP4WAIOps from Command Line", user has no idea where to install argocd CLI. Can provide external link to Argo CD website for this.
  • Remove "NOTE:" in this section where there's no bullets underneath.

Release CHECKLIST:

  • The links to "System requirements for Cloud Pak for Watson AIOps" and "Storage Considerations" need to be updated to reflect the 3.4 release contents when 3.4 release docs are available
  • Shall we move how-to-deploy-cp4waiops-xx.md to their own release branch or a separate branch for docs? To use release-3.4 branch to host docs for release other than 3.4 is confusing. Maybe we should create a separate branch to host docs dedicatedly so that all contents will be remained visible to gh-pages branch which will ultimately be seen at https://ibm.github.io/cp4waiops-gitops/docs/
  • Make sure the 3.4 release helm charts will ultimately be available at: https://ibm.github.io/cp4waiops-gitops/index.yaml.
commented

@morningspace Thanks for the review comments!

The "CP4WAIOps Advanced Install Options Using GitOps" link is broken.

the 3.4 is not release yet, so this link is pointing to the doc that yet to be available. so for now the best would be link to 3.3 instead, I'll update it.

The links to "System requirements for Cloud Pak for Watson AIOps" and "Storage Considerations" need to be updated to reflect the 3.4 release contents when 3.4 release docs are available

agreed, it's basically the same situation as the one above, let's keep these that way for now, we can update them after 3.4 doc available.

"Install CP4WAIOps from Command Line", user has no idea where to install argocd CLI. Can provide external link to Argo CD website for this.

for both UI and Cli section, the argocd install instruction is provided in the Prerequisite

Shall we move how-to-deploy-cp4waiops-xx.md to their own release branch or a separate branch for docs? To use release-3.4 branch to host docs for release other than 3.4 is confusing. Maybe we should create a separate branch to host docs dedicatedly so that all contents will be remained visible to gh-pages branch which will ultimately be seen at https://ibm.github.io/cp4waiops-gitops/docs/

It would be too fragmented if we move all these to different releases, I think there need to be a place to have the overall list for all releases we support, let's discuss how can we do that.

commented

It would be too fragmented if we move all these to different releases, I think there need to be a place to have the overall list for all releases we support, let's discuss how can we do that.

+1, now I am more on the option that we create a docs branch to host all docs in a central place, this also ease the doc publishing to gh-pages.

commented

@morningspace just updated the 3.4 doc, pls take a look, #163

commented

Remain this issue open as check list before GitOps install released as GA feature: #155 (comment)

commented

Updates:

The links to "System requirements for Cloud Pak for Watson AIOps" and "Storage Considerations" need to be updated to reflect the 3.4 release contents when 3.4 release docs are available.

  • This can be done now that 3.4 is GAed.

Make sure the 3.4 release helm charts will ultimately be available at: https://ibm.github.io/cp4waiops-gitops/index.yaml.

  • The index.yaml can be cleaned up by removing the historical unneeded charts
  • Also as we discussed at #177 (comment), for aimanager, suggest to name helm chart as aimanager, chart version as 3.4.0. For eventmanager, name helm chart as eventmanager, chart version as 3.4.0. Here 3.4 reflects the AIOps release version, the last revision reflects the helm chart updates from version to version. Changes need to be made in install-aimgr Chart.yaml and install-emgr Chart.yaml

Add to the 3.4.0 what’s new and have something to say that gitops is now supported, and have a new document created in the knowledge center so that search will find it in the future.

Docs need to be moved to CSM web site before GA.