Create portal README.md (#40)

* Create README.md Signed-off-by: Haytham Abuelfutuh <[email protected]> * Add default service account name Signed-off-by: Haytham Abuelfutuh <[email protected]> * Update README.md Signed-off-by: Haytham Abuelfutuh <[email protected]> * Update README.md Signed-off-by: Haytham Abuelfutuh <[email protected]>
flyteorg · Dec 28, 2021 · b19d3bc · b19d3bc
1 parent 3ff30f4
commit b19d3bc
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/flytetools/portal/README.md b/flytetools/portal/README.md
@@ -0,0 +1,37 @@
+# What's Portal
+
+Portal is a container containing a set of tools to help debug live services.. It can be deployed as a pod or a deployment to give you access to databases and 
+other IAM- or VPC- protected services.
+
+## Apply portal deployment
+
+Create portal deployment in `flyte` namespace:
+
+```bash
+kubectl apply -f https://raw.githubusercontent.com/flyteorg/flytetools/master/portal/deployment.yaml
+```
+
+### Use a different namespace
+
+```bash
+curl https://raw.githubusercontent.com/flyteorg/flytetools/master/portal/deployment.yaml | sed "s/namespace: flyte/namespace: union/" | kubectl apply -f -
+```
+
+### Use a different service account
+
+```bash
+curl https://raw.githubusercontent.com/flyteorg/flytetools/master/portal/deployment.yaml | sed "s/serviceAccountName: default/serviceAccountName: foo/" | kubectl apply -f -
+```
+
+## Open a shell into the deployed pod
+
+```bash
+kubectl exec -it -n flyte deploy/portal -- bash
+```
+
+## Tools available inside:
+
+- [X] postgresql-client (run `psql`)
+- [X] redis-client (run `redis-cli`)
+- [X] flytekit
+- [X] python3
diff --git a/flytetools/portal/deployment.yaml b/flytetools/portal/deployment.yaml
@@ -15,6 +15,7 @@ spec:
       labels:
         app: portal
     spec:
+      serviceAccountName: default
       containers:
       - name: portal
         image: ghcr.io/flyteorg/flyteportal:v0.42.0