Add document to help getting started with development #67

hogepodge · 2018-03-28T22:46:33Z

What this PR does / why we need it:

This PR outlines basic requirements for setting up a development environment for cloud-provider-openstack

Which issue(s) this PR fixes:
Fixes #20

Special notes for your reviewer:

Advice on making this more widely usable, based on your own experiences, are welcome.

Release note:

NONE

hogepodge · 2018-03-28T22:47:39Z

/assign @dims

zetaab · 2018-03-29T04:16:23Z

docs/getting-started-provider-dev.md

+cd ~
+git clond https://github.com/kubernetes/kubernetes
+cd kubernetes
+make


does it really work with make? I am using ./build/run.sh make && cd cluster/images/hyperkube && make push VERSION=dev ARCH=amd64

zetaab · 2018-03-29T04:17:13Z

docs/getting-started-provider-dev.md

+
+```
+cd ~
+git clone https://github.com/kubnernetes/cloud-provider-openstack


when compiling golang, the directory structure is important. For me this does not look like its correct if you just clone it to current default directory?

Right.

You need to export GOPATH as well and use k8s.io instead.

plus there is typo kubnernetes

dixudx · 2018-03-29T05:18:47Z

docs/getting-started-provider-dev.md

@@ -0,0 +1,199 @@
+# Getting Started with Cloud Provider OpenStack Development
+
+This guide will help you get started with building a development environment for you 


How about This guide will help you build and run a single node Kubernetes cluster with the OpenStack Cloud Provider enabled?

It's a bit of both. It's not just about running the code, but about having it available to develop and test against. We don't have any functional tests enabled, and this is part of the path towards getting those set up.

dixudx · 2018-03-29T05:20:58Z

docs/getting-started-provider-dev.md

+
+The specific values you use will vary based on your particular environment. You may
+notice that several values are aliases of one another. This is in part because the
+values expected by the OpenStack client and [Gopher Cloud]() are slightly different,


Missing link for Gophercloud project?

Yes, definitely a missing link.

dixudx · 2018-03-29T05:27:13Z

docs/getting-started-provider-dev.md

+
+```
+cd ~
+git clone https://github.com/kubnernetes/cloud-provider-openstack


Right.

You need to export GOPATH as well and use k8s.io instead.

dims · 2018-03-29T18:08:34Z

docs/getting-started-provider-dev.md

+export GOPATH=$HOME/go
+export GOROOT=/usr/local/go
+export PATH=$PATH:$GOROOT/bin
+export user={your github profile name}


USER right?

ah never mind, this is just for snippet below

dims · 2018-03-29T18:09:54Z

docs/getting-started-provider-dev.md

+export working_dir=$GOPATH/src/k8s.io
+```
+
+With your environment variables set up, clone the forks into your go environment.


Did we tell them earlier to fork cloud-provider-openstack and kubernetes repos?

dims · 2018-03-29T18:13:20Z

docs/getting-started-provider-dev.md

+cd $working_dir
+git clone https://github.com/{user}/kubernetes
+cd kubernetes
+make


what does this actually build? the following may work better to build-all-the-things

export KUBE_FASTBUILD=true make cross

According to https://github.com/kubernetes/kubernetes/tree/master/build#key-scripts make will build only the linux binaries.
AFAIK running make cross with KUBE_FASTBUILD=true on a linux platform should do the same.

I tried to create env with this guide but nothing happens when i run 'make', i need to run 'make build' then binaries are build.

dims · 2018-03-29T18:13:39Z

docs/getting-started-provider-dev.md

+domain-id=<domain_id>
+```
+
+Start your cluster with the `hack/local-up.sh` with the proper environment variable set to


hack/local-up-cluster.sh

dims · 2018-03-29T18:14:46Z

docs/getting-started-provider-dev.md

+
+To run the OpenStack provider, integrated with your cloud, be sure to have sourced the
+environment variables. You will also need to create an `/etc/kubernetes/cloud-config` file
+with the minimum options:


we can throw the url for the configuration options here too https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#cloudconf

That document is going away, and we should be hosting it in this repository.

dims · 2018-04-25T01:25:47Z

/hold

kiwik · 2018-06-07T06:47:13Z

/test cloud-provider-openstack-acceptance-test-e2e-conformance-stable-branch-v1.10

theopenlab-ci · 2018-06-07T08:27:03Z

Build succeeded.

cloud-provider-openstack-acceptance-test-e2e-conformance-stable-branch-v1.10 : SUCCESS in 1h 38m 45s

yuanying · 2018-06-15T00:13:16Z

docs/getting-started-provider-dev.md

+```
+GO_VERSION=1.10
+GO_ARCH=linux-amd64
+curl -o go.tgz https://dl.google.com/go/go$(GO_VERSION).$(GO_ARCH).tar.gz


I think this line should be
curl -o go.tgz https://dl.google.com/go/go${GO_VERSION}.${GO_ARCH}.tar.gz ?

adisky · 2018-06-29T06:42:51Z

docs/getting-started-provider-dev.md

+enable the external cloud provider:
+
+```
+export EXTERNAL_CLOUD_PROVIDER_BINARY=$GOPATH/src/git.openstack.org/openstack/openstack-cloud-controller-manager/openstack-cloud-controller-manager


I need to set
export EXTERNAL_CLOUD_PROVIDER_BINARY=$GOPATH/src/k8s.io/cloud-provider-openstack/openstack-cloud-controller-manager

k8s-ci-robot · 2018-07-03T20:14:18Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please email the CNCF helpdesk: helpdesk@rt.linuxfoundation.org

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.

theopenlab-ci · 2018-07-03T20:15:27Z

Build succeeded.

cloud-provider-openstack-format : SUCCESS in 2m 24s

theopenlab-ci · 2018-07-03T20:27:30Z

Build succeeded.

cloud-provider-openstack-format : SUCCESS in 1m 07s

dims · 2018-07-03T20:31:51Z

/hold cancel

theopenlab-ci · 2018-07-03T20:38:57Z

Build succeeded.

cloud-provider-openstack-unittest : SUCCESS in 12m 37s

theopenlab-ci · 2018-07-03T20:46:05Z

Build succeeded.

cloud-provider-openstack-acceptance-test-k8s-cinder : SUCCESS in 19m 36s

theopenlab-ci · 2018-07-03T20:49:19Z

Build succeeded.

cloud-provider-openstack-acceptance-test-lb-octavia : SUCCESS in 22m 53s

theopenlab-ci · 2018-07-03T20:55:56Z

Build succeeded.

cloud-provider-openstack-acceptance-test-csi-cinder : SUCCESS in 24m 39s

theopenlab-ci · 2018-07-03T20:58:28Z

Build succeeded.

cloud-provider-openstack-acceptance-test-standalone-cinder : SUCCESS in 32m 02s

theopenlab-ci · 2018-07-03T20:58:39Z

Build succeeded.

cloud-provider-openstack-acceptance-test-keystone-authentication-authorization : SUCCESS in 30m 40s

theopenlab-ci · 2018-07-03T21:08:09Z

Build succeeded.

cloud-provider-openstack-acceptance-test-flexvolume-cinder : SUCCESS in 40m 06s

theopenlab-ci · 2018-07-03T22:17:15Z

Build succeeded.

cloud-provider-openstack-acceptance-test-e2e-conformance : SUCCESS in 1h 45m 55s

theopenlab-ci · 2018-07-03T22:18:07Z

Build succeeded.

cloud-provider-openstack-acceptance-test-e2e-conformance-stable-branch-v1.10 : SUCCESS in 1h 46m 47s

theopenlab-ci · 2018-07-03T22:19:57Z

Build succeeded.

cloud-provider-openstack-acceptance-test-e2e-conformance-stable-branch-v1.11 : SUCCESS in 1h 48m 36s

dims · 2018-07-18T01:00:53Z

/lgtm
/approve

k8s-ci-robot · 2018-07-18T01:00:59Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dims

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:

~~OWNERS~~ [dims]

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

Merge https://github.com/kubernetes/cloud-provider-openstack:master into master

…der-dev Add document to help getting started with development

k8s-ci-robot requested review from dixudx and zetaab March 28, 2018 22:46

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 28, 2018

k8s-ci-robot assigned dims Mar 28, 2018

hogepodge mentioned this pull request Mar 28, 2018

Document how to run openstack-cloud-controller-manager with hack/local-up-cluster.sh #20

Closed

zetaab reviewed Mar 29, 2018

View reviewed changes

dixudx suggested changes Mar 29, 2018

View reviewed changes

hogepodge force-pushed the getting-started-provider-dev branch from b130eb5 to 6074b31 Compare March 29, 2018 17:20

dims reviewed Mar 29, 2018

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 25, 2018

yuanying reviewed Jun 15, 2018

View reviewed changes

adisky reviewed Jun 29, 2018

View reviewed changes

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 3, 2018

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. and removed cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 3, 2018

hogepodge force-pushed the getting-started-provider-dev branch from 8297540 to db7d665 Compare July 3, 2018 20:23

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 3, 2018

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 3, 2018

Add document to help getting started with development

f552975

hogepodge force-pushed the getting-started-provider-dev branch from db7d665 to f552975 Compare July 3, 2018 20:25

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 3, 2018

hogepodge mentioned this pull request Jul 5, 2018

Tracking Issue: Concise outline for using cloud providers kubernetes/kubeadm#526

Closed

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 18, 2018

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 18, 2018

k8s-ci-robot merged commit 576a02f into kubernetes:master Jul 18, 2018

jsafrane pushed a commit to jsafrane/cloud-provider-openstack that referenced this pull request Aug 23, 2021

Merge pull request kubernetes#67 from shiftstack/merge-bot-master

80fedbf

Merge https://github.com/kubernetes/cloud-provider-openstack:master into master

powellchristoph pushed a commit to powellchristoph/cloud-provider-openstack that referenced this pull request Jan 19, 2022

Merge pull request kubernetes#67 from hogepodge/getting-started-provi…

c67ceae

…der-dev Add document to help getting started with development

		@@ -0,0 +1,199 @@
		# Getting Started with Cloud Provider OpenStack Development

		This guide will help you get started with building a development environment for you

Add document to help getting started with development #67

Add document to help getting started with development #67

Conversation

hogepodge commented Mar 28, 2018 • edited

hogepodge commented Mar 28, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dims commented Apr 25, 2018

kiwik commented Jun 7, 2018

theopenlab-ci bot commented Jun 7, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

dims commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

theopenlab-ci bot commented Jul 3, 2018

dims commented Jul 18, 2018

k8s-ci-robot commented Jul 18, 2018

hogepodge commented Mar 28, 2018 •

edited