Skip to content
This repository has been archived by the owner on Oct 22, 2021. It is now read-only.

deploy docs appear to have diverged #1679

Open
jamespollard8 opened this issue Jan 8, 2021 · 0 comments
Open

deploy docs appear to have diverged #1679

jamespollard8 opened this issue Jan 8, 2021 · 0 comments
Assignees
Labels
Type: Bug Something isn't working

Comments

@jamespollard8
Copy link

jamespollard8 commented Jan 8, 2021

Additional context
We (@Birdrock and I) are two engineers from the cf-for-k8s team. (Hi! 👋 ) We wanted to tryout kubeCF and right away ran into issues trying to deploy. Some of our initial confusion came from finding several versions of the deploy documentation that give different instructions.

Describe the bug

For example, just following instructions for deploying the cf-operator, my pair and I found 3 different sets of instructions.

from https://kubecf.io/docs/deployment/kubernetes-deploy/ (I got here from kubecf.io -> documentation -> Deploy -> Deployment Walkthrough) I see
image
(suggests creating the namespace and running helm install cf-operator)

from https://github.com/cloudfoundry-incubator/kubecf/releases/tag/v2.7.1 (I got here from https://www.cloudfoundry.org/technology/kubecf/ -> Getting Started -> Quick Fresh Installation) I see
image
(doesn't suggest creating the namespace. Calls helm install cf-operator like the one above)

from https://github.com/cloudfoundry-incubator/kubecf/blob/v2.7.1/doc/dev/general.md#cf-operator (In the v2.7.1 release notes -> Quick Fresh Installation -> click on hyper link from "These are the basic guidelines to deploy KubeCF in a development environment. For more detailed information check here.")
image

(doesn't suggest creating the namespace. Calls helm install --name cf-operator even though that --name flag has been removed)

Minor other hiccups

  • the deploy docs also don't tell you exactly how to get ./cf-operator.tgz
  • it looks like cf-operator changed to quarks-operator and this is not yet reflected in the docs
@jamespollard8 jamespollard8 added the Type: Bug Something isn't working label Jan 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Type: Bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants