initial contributing (#8)

flyteorg · Aug 3, 2020 · 8774f00 · 8774f00
1 parent c17ee3b
commit 8774f00
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/flytectl/README.md b/flytectl/README.md
@@ -1,2 +1,5 @@
 # flytectl
 Flyte CLI
+
+
+[Contribution guidelines for this project](docs/CONTRIBUTING.md)
diff --git a/flytectl/docs/CONTRIBUTING.md b/flytectl/docs/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# Developing FlyteCtl
+
+A local cluster can be setup via --> https://lyft.github.io/flyte/administrator/install/getting_started.html#getting-started
+
+Then, if having trouble connecting to local cluster see the following:
+
+#1) Find/Set/Verify gRPC port for your local Flyte service:
+
+FLYTECTL_GRPC_PORT=`kubectl get service -n flyte flyteadmin -o json | jq '.spec.ports[] | select(.name=="grpc").port'`
+#2) Setup Port forwarding: kubectl port-forward -n flyte service/flyteadmin 8081:$FLYTECTL_GRPC_PORT
+
+and #3) Update config line in https://github.com/lyft/flytectl/blob/master/config.yaml to dns:///localhost:8081
+
+
+