Upgrade readme file #43

jasiu001 · 2019-10-16T11:34:13Z

Related to #35

mszostok · 2019-10-16T14:56:47Z

README.md


-1. Run the Minikube:


maybe we can just have a short script under the hack folder so user/developer will need to just execute
./hack/run-dev-kind.sh

this script can even automate that kind and helm will be downloaded for you if you will specify additional flag, we already have some helpers for that in /hack/ci dir.

so sth like:

./hack/run-dev-kind.sh --skip-deps-installation # such thing will resuse your own kind and helm # or ./hack/run-dev-kind.sh --install-deps # such thing will install own kind and helm instead of reusing your own

I do not have strong preferences if skip or install is a better approach

WDYT?
because copying that each time is boring :(

mszostok · 2019-10-16T14:57:22Z

README.md

-* [Helm CLI](https://github.com/kubernetes/helm#install)
-* [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) for local installation
+* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) 1.16
+* [Helm CLI](https://github.com/kubernetes/helm#install) 2.10


why we cannot use helm 2.14 or 2.15?

tested. can be :)

mszostok · 2019-10-16T15:02:07Z

README.md

+helm init --wait
+```
+
+3. Create ServiceAccount for Tiller with admin privileges


imo it should be in different order:

shout '- Installing Tiller...' kubectl --namespace kube-system create sa tiller kubectl create clusterrolebinding tiller-cluster-rule --clusterrole=cluster-admin --serviceaccount=kube-system:tiller helm init --service-account tiller --upgrade --wait

Order is the same: create serviceaccount, create clusterrolebinding,
the difference is the last command: helm init instead patch deploy. Do you mean change command? Is there something wrong with patch?

mszostok · 2019-10-16T15:07:18Z

README.md

+  ├── docs                        # Documentation files
+  ├── hack                        # Various scripts that are used by Helm Broker developers
+  ├── internal                    # Private application and library code
+  ├── pkg                         # Library code to use by external applications


could you add also short readme to pkg, similar to this one: https://github.com/kyma-project/helm-broker/tree/master/hack

this folder is quite important and IMO is good to have a clear statement about its purpose

same thing for test folder, so it's dedicated for integrations/e2e etc. do not store there e.g. verify-gofmt.sh script, or sth similar because such thing should be placed under /hack dir.

klaudiagrz · 2019-10-16T14:29:24Z

README.md

-* [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) for local installation
+* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) 1.16
+* [Helm CLI](https://github.com/kubernetes/helm#install) 2.10
+* [docker](https://docs.docker.com/install/) 19.03 (for local installation)


Suggested change

* [docker](https://docs.docker.com/install/) 19.03 (for local installation)

* [Docker](https://docs.docker.com/install/) 19.03 (for local installation)

klaudiagrz · 2019-10-16T14:30:00Z

README.md

+* [docker](https://docs.docker.com/install/) 19.03 (for local installation)
+* [Kind](https://github.com/kubernetes-sigs/kind#installation-and-usage) 0.5 (for local installation) 
+
+for non-local installation (without kind) use Kubernetes in version 1.15


Suggested change

for non-local installation (without kind) use Kubernetes in version 1.15

>**NOTE:** For non-local installation, use Kubernetes v1.15.

klaudiagrz · 2019-10-17T08:44:07Z

README.md


-1. Run the Minikube:
+1. Create local cluster with Kind (making sure the docker is turned on):


Suggested change

1. Create local cluster with Kind (making sure the docker is turned on):

1. Create a local cluster on Kind:

klaudiagrz · 2019-10-17T08:44:48Z

README.md

+helm init --wait
+```
+
+3. Create ServiceAccount for Tiller with admin privileges


Suggested change

3. Create ServiceAccount for Tiller with admin privileges

3. Create a ServiceAccount for Tiller with admin privileges:

klaudiagrz · 2019-10-17T08:45:11Z

README.md

 ```

-3. Install the Service Catalog as a Helm chart:
+4. Install the Service Catalog as a Helm chart:


Suggested change

4. Install the Service Catalog as a Helm chart:

4. Install Service Catalog as a Helm chart:

klaudiagrz · 2019-10-17T08:45:28Z

README.md

 ```bash
 helm repo add svc-cat https://svc-catalog-charts.storage.googleapis.com
 helm install svc-cat/catalog --name catalog --namespace catalog
 ```

-4. Install the Helm Broker chart:
+5. Clone Helm Broker repository


Suggested change

5. Clone Helm Broker repository

5. Clone the Helm Broker repository:

klaudiagrz · 2019-10-17T08:49:20Z

README.md

+  ├── config                      # Configuration file templates or default configs
+  ├── deploy                      # Dockerfiles to build images
+  ├── docs                        # Documentation files
+  ├── hack                        # Various scripts that are used by Helm Broker developers


Suggested change

├── hack # Various scripts that are used by Helm Broker developers

├── hack # Scripts used by the Helm Broker developers

klaudiagrz · 2019-10-17T08:49:49Z

README.md

+  ├── hack                        # Various scripts that are used by Helm Broker developers
+  ├── internal                    # Private application and library code
+  ├── pkg                         # Library code to use by external applications
+  └── test                        # Additional external test apps and test data


Suggested change

└── test # Additional external test apps and test data

└── test # Additional external test applications and test data

klaudiagrz · 2019-10-17T08:50:35Z

README.md

+  ├── .github                     # Pull request and issue templates    
+  ├── charts                      # Charts to install by Helm
+  ├── cmd                         # Main applications for project                                     
+  ├── config                      # Configuration file templates or default configs


Suggested change

├── config # Configuration file templates or default configs

├── config # Configuration file templates or default configurations

mszostok · 2019-10-17T13:19:30Z

hack/run-dev-kind.sh

+  helm init --service-account tiller --upgrade --wait
+}
+
+tiller::assert_tiller_is_up() {


nit: this can be dropped because we already using the --wait flag during the init action

I prefer to leave it, if everything will be ok then it is only one iteration and we will be sure tiller is up.

mszostok · 2019-10-17T13:21:54Z

README.md

+* [Docker](https://docs.docker.com/install/) 19.03 (for local installation)
+* [Kind](https://github.com/kubernetes-sigs/kind#installation-and-usage) 0.5 (for local installation) 
+
+>**NOTE:** For non-local installation, use Kubernetes v1.15.

 ## Installation 


We should somewhere describe that you can just execute the
./hack/run-dev-kind.sh which will execute all those steps for you. Now it is a piece of secret knowledge.

IMO here we can have just info about this script with prerequisite and in the directory where this ./hack/run-dev-kind.sh have details what is done under the hood and if someone wants to do it manually then can do it.

mszostok · 2019-10-17T13:25:28Z

hack/run-dev-kind.sh

+
+set -o errexit
+
+readonly SUPPORTED_KIND_VERSION="v0.5.1"


just require this specified in deps_ver.sh

Upgrade readme file

d68ed6c

jasiu001 added area/documentation Issues or PRs related to documentation area/service-management Issues or PRs related to service management labels Oct 16, 2019

jasiu001 added this to the Sprint_Gopher_28 milestone Oct 16, 2019

jasiu001 requested review from alexandra-simeonova, bszwarc, kazydek, klaudiagrz, majakurcius, mmitoraj and tomekpapiernik as code owners October 16, 2019 11:34

mszostok reviewed Oct 16, 2019

View reviewed changes

klaudiagrz reviewed Oct 17, 2019

View reviewed changes

Fix after CR#1

0c024f0

jasiu001 requested review from adamwalach, piotrmiskiewicz, PK85 and polskikiel as code owners October 17, 2019 13:08

mszostok reviewed Oct 17, 2019

View reviewed changes

klaudiagrz approved these changes Oct 17, 2019

View reviewed changes

Fix after CR#2

407a9d6

klaudiagrz assigned mszostok Oct 18, 2019

mszostok approved these changes Oct 18, 2019

View reviewed changes

jasiu001 merged commit 5886410 into SAP-archive:master Oct 18, 2019

mszostok added the kind/feature Categorizes issue or PR as related to a new feature. label Oct 23, 2019

jasiu001 deleted the readme branch June 25, 2021 08:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade readme file #43

Upgrade readme file #43

jasiu001 commented Oct 16, 2019

mszostok Oct 16, 2019

mszostok Oct 16, 2019

jasiu001 Oct 17, 2019

mszostok Oct 16, 2019

jasiu001 Oct 17, 2019

mszostok Oct 16, 2019

klaudiagrz Oct 16, 2019

klaudiagrz Oct 16, 2019

klaudiagrz Oct 17, 2019

klaudiagrz Oct 17, 2019

jasiu001 Oct 17, 2019

klaudiagrz Oct 17, 2019

klaudiagrz Oct 17, 2019

klaudiagrz Oct 17, 2019

klaudiagrz Oct 17, 2019

klaudiagrz Oct 17, 2019

mszostok Oct 17, 2019 •

edited

Loading

jasiu001 Oct 18, 2019

mszostok Oct 17, 2019

mszostok Oct 17, 2019

	* [docker](https://docs.docker.com/install/) 19.03 (for local installation)
	* [Docker](https://docs.docker.com/install/) 19.03 (for local installation)

	for non-local installation (without kind) use Kubernetes in version 1.15
	>NOTE: For non-local installation, use Kubernetes v1.15.


		1. Run the Minikube:
		1. Create local cluster with Kind (making sure the docker is turned on):

	1. Create local cluster with Kind (making sure the docker is turned on):
	1. Create a local cluster on Kind:

	3. Create ServiceAccount for Tiller with admin privileges
	3. Create a ServiceAccount for Tiller with admin privileges:

	4. Install the Service Catalog as a Helm chart:
	4. Install Service Catalog as a Helm chart:

	5. Clone Helm Broker repository
	5. Clone the Helm Broker repository:

	├── hack # Various scripts that are used by Helm Broker developers
	├── hack # Scripts used by the Helm Broker developers

	└── test # Additional external test apps and test data
	└── test # Additional external test applications and test data

	├── config # Configuration file templates or default configs
	├── config # Configuration file templates or default configurations


		set -o errexit

		readonly SUPPORTED_KIND_VERSION="v0.5.1"

Upgrade readme file #43

Upgrade readme file #43

Conversation

jasiu001 commented Oct 16, 2019

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

mszostok Oct 17, 2019 • edited Loading

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

mszostok Oct 17, 2019 •

edited

Loading