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

Update Readme for simplified Kops 1.10 instructions #135

Merged
merged 1 commit into from
Jan 10, 2019

Conversation

rifelpet
Copy link
Contributor

Kops 1.10 was released 2 days ago which adds support for managing the AWS IAM Authenticator via the cluster spec. This greatly simplifies the install instructions.

It does require Kops 1.10 and Kubernetes 1.10, so if theres a desire to maintain both sets of instructions I can update this PR to do so.

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

@christopherhein christopherhein left a comment

Choose a reason for hiding this comment

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

Can we change one thing?

README.md Outdated
If the cluster already exists, roll the cluster with `kops rolling-update cluster ${CLUSTER_NAME}` in order to recreate the master nodes.
4. Update the Authenticator DaemonSet's state and output volumes to both use `/srv/kubernetes/aws-iam-authenticator/` for their `hostPath`s.
5. Apply the DaemonSet and ConfigMap resource manifests to launch the Authenticator server on the cluster.

*Note:* Certain Kops commands will overwrite the `ExecCredential` in kubeconfig so it may need to be restored manually. See [kubernetes/kops#5051](https://github.com/kubernetes/kops/issues/5051) for more information.
Copy link
Member

Choose a reason for hiding this comment

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

We should probably change this to say something like "If you are using Kops <1.10 …" instead of "Certain Kops" since the 1.10 Kops fixes this bug by supporting client-go 7.0

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's kind of strange to provide instructions that require >=1.10 and then give a warning about behavior when using <1.10. Maybe we just remove the warning altogether if we're not going to provide instructions for <1.10 ?

Copy link
Member

Choose a reason for hiding this comment

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

That's a fair point. Removing is probably the better option.

@rifelpet rifelpet force-pushed the dev branch 2 times, most recently from 5e5b5f8 to 6568a4a Compare August 20, 2018 17:04
@rifelpet
Copy link
Contributor Author

Updated to remove outdated note

@dhemeier
Copy link

dhemeier commented Sep 5, 2018

Hey @rifelpet ,

I had currently tested to change to aws-authenticator on one of my clusters. You don't need to do a rolling-update on existing clusters anymore. The aws-iam-authenticator deployed directly after the kops update cluster --yes. So you could also remove the rolling-update task from the description.

@dhemeier
Copy link

dhemeier commented Sep 6, 2018

Sorry this is not correct,

all deployments and folders are created on the master, but the certificates are only inserted on instance launch. So you need the rolling-update.

But then Kops have a problem, they don't display a "needs update" message, so you can only deploy the master again with kops rolling-update cluster --instance-group master-XX-XX-XX --force --yes

Sorry for my mistake.

@rifelpet
Copy link
Contributor Author

@dhemeier Thanks for the heads up, I've updated the rolling-update command to include --force, and added --yes to both update and rolling-update.

README.md Outdated

2. Apply the changes with `kops update cluster ${CLUSTER_NAME} --yes`.
If the cluster already exists, roll the cluster with `kops rolling-update cluster ${CLUSTER_NAME} --force --yes` in order to recreate the master nodes.
Copy link

Choose a reason for hiding this comment

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

If only the master nodes need to be rolled, then use kops rolling-update cluster ${CLUSTER_NAME} --instance-group ${MASTER_INSTANCE_GROUP_NAME} --force --yes to prevent unnecessary recycling of the nodes.

Choose a reason for hiding this comment

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

More generically one could also just do kops rolling-update cluster ${CLUSTER_NAME} --instance-group-roles=Master --force --yes

@somcsel
Copy link

somcsel commented Sep 19, 2018

According to the kops docs a ConfigMap also needs to be created. Without this, the cluster will not validate and the aws-iam-authenticator Pod will not start.

@somcsel
Copy link

somcsel commented Sep 19, 2018

Perhaps it would be better to maintain one set of authoritative instructions in the kops git and just link to them from this README?

@rifelpet
Copy link
Contributor Author

@somcsel Agreed. I've updated this PR to just point to the kops documentation. I added some additional instructions over there so hopefully it should be sufficient on its own.

@nckturner
Copy link
Contributor

@christopherhein is this ok to merge?

@christopherhein
Copy link
Member

/lgtm

@nckturner I'm good with these updates.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 19, 2018
@rifelpet
Copy link
Contributor Author

rifelpet commented Nov 2, 2018

Is there any way we can get this merged? CC @nckturner

@nckturner
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: nckturner, rifelpet

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 Jan 10, 2019
@k8s-ci-robot k8s-ci-robot merged commit 5956059 into kubernetes-sigs:master Jan 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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 "Looks good to me", 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.

7 participants