Skip to content
This repository has been archived by the owner on May 6, 2022. It is now read-only.

Update minikube start docs #2365

Merged
merged 3 commits into from
Sep 28, 2018

Conversation

carolynvs
Copy link
Contributor

@carolynvs carolynvs commented Sep 27, 2018

This PR is a

  • Feature Implementation
  • Bug Fix
  • Documentation

What this PR does / why we need it:
Updates our doc to match breaking changes in minikube.

Preview available at: https://deploy-preview-2365--svc-cat.netlify.com/docs/install/#minikube

Which issue(s) this PR fixes

Fixes #2325

Please leave this checklist in the PR comment so that maintainers can ensure a good PR.

Merge Checklist:

  • New feature
    • Tests
    • Documentation
  • SVCat CLI flag
  • Server Flag for config
    • Chart changes
    • removing a flag by marking deprecated and hiding to avoid
      breaking the chart release and existing clients who provide a
      flag that will get an error when they try to update

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 27, 2018
Copy link
Contributor

@shubheksha shubheksha left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@shubheksha
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 28, 2018
docs/install.md Outdated

```console
minikube start --extra-config=apiserver.Authorization.Mode=RBAC
minikube start ----bootstrapper=kubeadm --extra-config=apiserver.authorization-mode=RBAC
Copy link
Contributor

Choose a reason for hiding this comment

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

According to kubernetes/minikube#1722 (comment) minikube enables RBAC by default as of v0.26.0

Additionally, my read on this for syntax: If you are using minikube versions v25.2 or older you need to use the old syntax --extra-config=apiserver.Authorization.Mode=RBAC but if you are using newer version (ie V26.0 or newer), you need to specify --extra-config=apiserver.authorization-mode=RBAC. OR don't specify extra config at all. Those details from kubernetes/minikube#2798 (comment)

I'd rework this to say:
if using Minikube v0.25 or older, you must specify

minikube start --extra-config=apiserver.Authorization.Mode=RBAC

If using v0.26 or newer, do not specify extra-config. Using "--extra-config=apiserver.Authorization.Mode" in v0.26 or greater may result in a hang as the flag has been changed to --extra-config=apiserver.authorization-mode and the default is to use RBAC. Start minikube with

minikube start 

I believe these details are accurate, I'd prefer to specify specific versions and remove the word "you may not need to specify" from the text immediately following this. :)

@k8s-ci-robot k8s-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Sep 28, 2018
@carolynvs
Copy link
Contributor Author

@jboyd01 I've update the PR to incorporate your clarification around --extra-config. 👍

@jboyd01
Copy link
Contributor

jboyd01 commented Sep 28, 2018

Thanks for fixing @carolynvs!
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 28, 2018
@carolynvs
Copy link
Contributor Author

@jboyd01 Can you slap on a approve since Shubeksha has already done the lgtm?

@k8s-ci-robot k8s-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Sep 28, 2018
@MHBauer
Copy link
Contributor

MHBauer commented Sep 28, 2018

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 28, 2018
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: MHBauer

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 28, 2018
docs/install.md Outdated

With Minikube v0.26+, do not specify `--extra-config`. The
flag has since been changed to `--extra-config=apiserver.authorization-mode` and
the Minikube now uses RBAC by default. Specifying the older flag may cause the
Copy link
Contributor

Choose a reason for hiding this comment

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

the Minikube -> Minikube

@k8s-ci-robot k8s-ci-robot merged commit 22ac281 into kubernetes-retired:master Sep 28, 2018
@carolynvs carolynvs deleted the fix-minikube-docs branch October 4, 2018 21:29
jboyd01 pushed a commit to jboyd01/service-catalog that referenced this pull request Oct 31, 2018
* Update minikube start docs

* Clarify when to use the extra-config flag

* nit - the Minikube -> Minikube
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Minikube related SC installation instructions are outdated
6 participants