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.

Sign up for GitHub

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

Jump to bottom

Adds docs on how to run operator locally #42

Merged
merged 1 commit into from
Feb 24, 2020
Merged

Adds docs on how to run operator locally #42

merged 1 commit into from
Feb 24, 2020

Conversation

somtochiama
Copy link
Member

@somtochiama somtochiama commented Feb 24, 2020 •
edited
Loading

This PR adds how to run the operator locally.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 24, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @somtochiama!

It looks like this is your first PR to kubernetes-sigs/cluster-addons 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-addons has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 24, 2020
johnsonj
johnsonj reviewed Feb 24, 2020
View reviewed changes
coredns/README.md
Running the operator locally:

```bash
export GOPATH=<go-path>
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for adding this @somtochiama !

We're using Go modules for this project so a user shouldn't need to set GOPATH. Do these instructions work with setting GO111MODULE=on instead of GOPATH=..?

Instead of go build and running bin/manager, i'd suggest putting make run after make install. This ensures all files are generated.

Copy link
Member Author

Choose a reason for hiding this comment

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

Okay. I will try to do it without setting GOPATH and if it works, I will update the PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

The "generate" command in the make file checks if the GOPATH is set else it exits with an error. Therefore make run need the GOPATH Set.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ohh- thank you! Let's go with this as it is then. We're still in the weird world where go modules exists, but not everywhere :)

@johnsonj
Copy link
Contributor

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 24, 2020
@johnsonj
Copy link
Contributor

/approved

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: johnsonj, SomtochiAma

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 Feb 24, 2020
@k8s-ci-robot k8s-ci-robot merged commit ea0bf5a into kubernetes-sigs:master Feb 24, 2020
@somtochiama somtochiama deleted the improve-docs branch March 3, 2020 18:52
@somtochiama somtochiama mentioned this pull request Aug 14, 2020
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johnsonj johnsonj johnsonj left review comments

@justinsb justinsb Awaiting requested review from justinsb

@stealthybox stealthybox Awaiting requested review from stealthybox

Assignees

@johnsonj johnsonj

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/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@somtochiama @k8s-ci-robot @johnsonj