[DOCS-13807] k8s enterprise operator installation instructions needs a correction Created: 04/Aug/20  Updated: 29/Oct/23  Resolved: 13/Aug/20

Status: Closed
Project: Documentation
Component/s: Kubernetes Operator
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Minor - P4
Reporter: Jeegar Ghodasara Assignee: Melissa Mahoney
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 3 years, 27 weeks ago
Epic Link: DOCSP-3291
Story Points: 2

 Description   

Description

The Scope of the k8s enterprise operator is cluster-wide, same namespace as resource, or different namespace than resource.

 

For both cluster-wide scope and different namespace scope, the documentation says operator "MUST be installed with helm" which is not correct.

 

Link to the doc: https://docs.mongodb.com/kubernetes-operator/v1.6/tutorial/plan-k8s-op-considerations/#k8s-op-short-deployment-scopes

Operator in Different Namespace Than Resources

You scope the Kubernetes Operator to a namespace. The Kubernetes Operator watches Ops Manager and MongoDB Kubernetes resources in the namespace you specify.

You must use helm to install the Kubernetes Operator with this scope. Follow the relevant helm installation instructions, but use the following command to set the namespace for the Kubernetes Operator to watch:

Scope of changes

  • Remove "must"
  • Include that helm is preferred
  • Point to/note on how to do it without helm

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Melissa Mahoney [ 05/Aug/20 ]

Context from Slack:

cian.hatton 1 day ago
it is possible to install a cluster wide operator without helm.
The only requirement is that you specify a WATCH_NAMESPACE environment variable with a value of *
https://github.com/mongodb/mongodb-enterprise-kubernetes/blob/master/mongodb-enterprise.yaml#L205

Jeegar 1 day ago
By the way would you say a doc ticket is needed to clarify this in the docs; it says “MUST USE Helm”. Use of “must” makes it sound like hard requirement.

cian.hatton 1 day ago
yes I agree, helm is the preferred installation mechanism now but it is not a hard requirement

Generated at Thu Feb 08 08:08:46 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.