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

Document how to build and deploy the sample-apiserver #73447

Merged

Conversation

@MikeSpreitzer
Copy link
Member

commented Jan 29, 2019

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change

/kind bug

/kind cleanup
/kind design
/kind documentation
/kind failing-test
/kind feature
/kind flake

What this PR does / why we need it:
This PR fixes a documentation bug, in the README for the sample-apiserver.

Which issue(s) this PR fixes:

Fixes #73390

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Improved README for k8s.io/sample-apiserver
@MikeSpreitzer

This comment has been minimized.

Copy link
Member Author

commented Jan 29, 2019

@neolit123
Copy link
Member

left a comment

@MikeSpreitzer added a couple of minor nits
thanks.

not a bug, but instead a docs improvement.
/remove-kind bug
/kind documentation
/priority important-longterm

Show resolved Hide resolved staging/src/k8s.io/sample-apiserver/README.md Outdated
Show resolved Hide resolved staging/src/k8s.io/sample-apiserver/README.md Outdated
@MikeSpreitzer

This comment has been minimized.

Copy link
Member Author

commented Jan 29, 2019

@neolit123 : thanks!
I have also realized that hack/update-codegen.sh is not designed to be used by a developer who has done go get k8s.io/sample-apiserver; we need an alternative for such a developer, or modify the existing one (and how it is used by the build/test of k/k).

@yliaog

This comment has been minimized.

Copy link
Contributor

commented Jan 31, 2019

/cc

@k8s-ci-robot k8s-ci-robot requested a review from yliaog Jan 31, 2019

@roycaihw

This comment has been minimized.

Copy link
Member

commented Jan 31, 2019

@dims

This comment has been minimized.

Copy link
Member

commented Jan 31, 2019

@caesarxuchao

This comment has been minimized.

Copy link
Member

commented Jan 31, 2019

I would reference the docker build mentioned by @dims, and point out that it's building a specific version of the sample-apiserver. It also handles different architecture.

The doc on building and deploying lgtm.


```
docker build -t MYPREFIX/kube-sample-apiserver:MYTAG ./artifacts/simple-image
docker push MYPREFIX/kube-sample-apiserver:MYTAG

This comment has been minimized.

Copy link
@caesarxuchao

caesarxuchao Feb 12, 2019

Member

Can you update the hack/build-image.sh?

Maybe we can add the go build command to the script as well.

This comment has been minimized.

Copy link
@MikeSpreitzer

MikeSpreitzer May 9, 2019

Author Member

I presume hack/build-image.sh is used by some stuff, which would have to be changed if I modified that script to take MYPREFIX and MYTAG as parameters --- but I do not know what that stuff is. I suggest leaving this to a separate PR.

@MikeSpreitzer MikeSpreitzer force-pushed the MikeSpreitzer:sample-apiserver-doc-build branch from 9496fb4 to d7d53d6 May 9, 2019

@k8s-ci-robot k8s-ci-robot added the size/M label May 9, 2019

@MikeSpreitzer MikeSpreitzer force-pushed the MikeSpreitzer:sample-apiserver-doc-build branch from d7d53d6 to 0613bf2 May 9, 2019

@MikeSpreitzer

This comment has been minimized.

Copy link
Member Author

commented May 15, 2019

@sttts : your comments reflect the expectation I came in with, which is that github.com/kubernetes/sample-apiserver should be a complete illustration of what a developer would do. But what I have discovered is that key pieces have been developed only to run in the context of k/k CI.

to something suitable. Then call:

```
kubectl apply -f artifacts/example

This comment has been minimized.

Copy link
@sttts

sttts May 15, 2019

Contributor

Is this so clever to create the namespace first?

This comment has been minimized.

Copy link
@MikeSpreitzer

MikeSpreitzer May 15, 2019

Author Member

I must admit I have done only limited testing. I see that if files and directories are traversed in alphabetical order then the ns.yaml is applied before any YAML that needs the namespace to exist.

@sttts

This comment has been minimized.

Copy link
Contributor

commented May 15, 2019

👍 for writing this down. Left some comments.

MikeSpreitzer added some commits Jan 29, 2019

Fixed sample-apiserver/hack/update-codegen.sh to not rely on codegen …
…scripts being executable

Apparently `go mod vendor` does not get executable bits set in vendor.

@MikeSpreitzer MikeSpreitzer force-pushed the MikeSpreitzer:sample-apiserver-doc-build branch from ad4da90 to 9a4081f May 16, 2019

@MikeSpreitzer MikeSpreitzer force-pushed the MikeSpreitzer:sample-apiserver-doc-build branch from 00933bc to 35710c5 May 18, 2019

@MikeSpreitzer

This comment has been minimized.

Copy link
Member Author

commented May 18, 2019

@sttts , @caesarxuchao : updated, PTAL

@MikeSpreitzer

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

/retest
These all look like flakes.

@k8s-ci-robot k8s-ci-robot added size/L and removed size/M labels May 20, 2019

@MikeSpreitzer MikeSpreitzer force-pushed the MikeSpreitzer:sample-apiserver-doc-build branch 2 times, most recently from 91b8e51 to 5872e0a May 20, 2019

sample-apiserver/README: documented authentication plugins, wget
Also fixed indenting in instructions for running locally.

@MikeSpreitzer MikeSpreitzer force-pushed the MikeSpreitzer:sample-apiserver-doc-build branch from 5872e0a to ba5d896 May 20, 2019

@k8s-ci-robot

This comment has been minimized.

Copy link
Contributor

commented May 20, 2019

@MikeSpreitzer: The following test failed, say /retest to rerun them all:

Test name Commit Details Rerun command
pull-kubernetes-e2e-kops-aws 9496fb4 link /test pull-kubernetes-e2e-kops-aws

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@krzyzacy

This comment has been minimized.

Copy link
Member

commented May 20, 2019

/skip pull-kubernetes-e2e-kops-aws

@MikeSpreitzer

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

/retest

@sttts

This comment has been minimized.

Copy link
Contributor

commented May 30, 2019

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm label May 30, 2019

@sttts sttts added this to the v1.15 milestone May 30, 2019

@k8s-ci-robot

This comment has been minimized.

Copy link
Contributor

commented May 30, 2019

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: MikeSpreitzer, sttts

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 merged commit 9577cbf into kubernetes:master May 30, 2019

20 checks passed

cla/linuxfoundation MikeSpreitzer authorized
Details
pull-kubernetes-bazel-build Job succeeded.
Details
pull-kubernetes-bazel-test Job succeeded.
Details
pull-kubernetes-conformance-image-test Skipped.
pull-kubernetes-cross Skipped.
pull-kubernetes-dependencies Job succeeded.
Details
pull-kubernetes-e2e-gce Job succeeded.
Details
pull-kubernetes-e2e-gce-100-performance Job succeeded.
Details
pull-kubernetes-e2e-gce-csi-serial Skipped.
pull-kubernetes-e2e-gce-device-plugin-gpu Job succeeded.
Details
pull-kubernetes-e2e-gce-storage-slow Skipped.
pull-kubernetes-godeps Skipped.
pull-kubernetes-integration Job succeeded.
Details
pull-kubernetes-kubemark-e2e-gce-big Job succeeded.
Details
pull-kubernetes-local-e2e Skipped.
pull-kubernetes-node-e2e Job succeeded.
Details
pull-kubernetes-typecheck Job succeeded.
Details
pull-kubernetes-verify Job succeeded.
Details
pull-publishing-bot-validate Skipped.
tide In merge pool.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.