doc: Add quickstart guide to README #126

hessjcg · 2022-12-06T16:07:01Z

Adds quickstart instructions to the README. This tells the user how to follow the existing
Cloud SQL Quickstart on GKE guide, adding a few extra steps in the middle, to try out
the operator.

kurtisvg · 2022-12-06T16:19:36Z

README.md

+your kuberentes cluster:
+
+```shell
+curl -o install.sh https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy-operator-dev/0.0.5/install.sh


The version in the version.txt is 0.0.2-dev?

I've updated make generate to ensure this is consistent this going forward.

kurtisvg · 2022-12-06T16:19:57Z

README.md

+
+```shell
+curl -o install.sh https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy-operator-dev/0.0.5/install.sh
+bash install.sh


Should we just pipe the url to bash?

kurtisvg · 2022-12-06T16:20:40Z

README.md

+      portEnvName: "DB_PORT"
+      hostEnvName: "INSTANCE_HOST"
+      socketType: "tcp"


Are these required to specify or just the default?

You have to specify portEnvName and hostEnvName or else the environment variables will not be set.

kurtisvg · 2022-12-06T16:21:21Z

README.md

@@ -9,34 +9,140 @@ which specifies the Cloud SQL Auth Proxy configuration for a workload. The opera
 reads this resource and adds a properly configured Cloud SQL Auth Proxy container
 to the matching workload pods. 

-## Setting up the initial project
-These commands will be run to initialize the kubebuilder project 
+# Quick Start


Seems like this should be an h2?

kurtisvg · 2022-12-06T16:22:26Z

README.md

+Note that there are now two containers on the pods, while there is only one
+container on the deployment. The operator adds a second proxy container configured


Suggested change

Note that there are now two containers on the pods, while there is only one

container on the deployment. The operator adds a second proxy container configured

Note that there are now two containers in the pods, while there is only one

container in the original deployment. The operator adds a second proxy container configured

kurtisvg · 2022-12-06T16:26:47Z

README.md

@@ -9,34 +9,140 @@ which specifies the Cloud SQL Auth Proxy configuration for a workload. The opera
 reads this resource and adds a properly configured Cloud SQL Auth Proxy container
 to the matching workload pods. 

-## Setting up the initial project
-These commands will be run to initialize the kubebuilder project 
+# Quick Start


More of a meta discussion: is QuickStart the right format for the README?

The rest of our repos start with Installations and follow up with Usage instructions that specify how to configure it in different ways. Should we adopt a similar format?

Maybe a Quickstart is a something that could go in the examples folder, and we can link to it as a "try this out quickly option" at the top the README

Good idea. I'll move it around.

enocom · 2022-12-08T17:53:16Z

README.md

-rm -rf bin
-.bin/kubebuilder init --owner "Google LLC" --project-name "cloud-sql-proxy-operator" --domain cloud.google.com --repo github.com/GoogleCloudPlatform/cloud-sql-proxy-operator
+```shell
+curl https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy-operator/v0.0.2-dev/install.sh | bash


Fixed. This is automatically updated by make generate match version.txt

enocom · 2022-12-08T17:54:22Z

docs/examples/deployment-postgres-tcp.yaml

+    name: "gke-cloud-sql-app" # named 'gke-cloud-sql-app'
+  instances:
+    - connectionString: "my-project:us-central1:instance" # from your Cloud SQL Database instance
+      socketType: "tcp" # Proxy will open a TCP socket for this instance


If this isn't required, let's leave it off.

enocom · 2022-12-08T17:54:48Z

docs/examples/deployment-postgres-tcp.yaml

+  name: gke-cloud-sql-operator-demo
+type: Opaque
+data:
+  DB_PASS: cGFzc3dvcmQ= # "password"


Is it worth adding a comment about how to generate these?

enocom · 2022-12-08T17:55:43Z

docs/quick-start.md

@@ -0,0 +1,131 @@
+# Quick Start                                                                                                    -# Quick Start
+Follow the instructions in the Quick Start Guide for Cloud SQL: [Connect to Cloud SQL for PostgreSQL from Google Kubernetes Engine](https://cloud.google.com/sql/docs/postgres/connect-instance-kubernetes)


Let's wrap the lines at 80 characters and use shortlinks.

enocom · 2022-12-08T17:56:02Z

docs/quick-start.md

+your kuberentes cluster:
+
+```shell
+curl https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy-operator/v0.0.2-dev/install.sh | bash


Fixed. This automatically is updated by make generate

enocom · 2022-12-08T17:56:13Z

docs/quick-start.md

+    - connectionString: "<INSTANCE_CONNECTION_NAME>"
+      portEnvName: "DB_PORT"
+      hostEnvName: "INSTANCE_HOST"
+      socketType: "tcp"


Again socketType can go?

enocom · 2022-12-08T17:56:53Z

tools/publish-installer.sh

 set -euxo
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 PROJECT_DIR=$( dirname "$SCRIPT_DIR")

 cd "$PROJECT_DIR"

+
+RELEASE_PROJECT_ID="cloud-sql-connectors"


Should this be part of a separate commit?

Yes, this is actually done in #136. It will disappear from this PR once #136 is merged.

…rsion.txt

…y readme.

Eno reviewed.

hessjcg requested a review from a team December 6, 2022 16:07

blunderbuss-gcf bot assigned enocom Dec 6, 2022

kurtisvg previously requested changes Dec 6, 2022

View reviewed changes

hessjcg requested a review from kurtisvg December 6, 2022 19:04

hessjcg force-pushed the onboard-docs branch from 60d49e3 to bdf4c4f Compare December 7, 2022 16:55

hessjcg mentioned this pull request Dec 7, 2022

doc: add example configuration for postgres unix and tcp sockets #127

Closed

hessjcg force-pushed the onboard-docs branch from 00784dd to cb944fe Compare December 8, 2022 15:57

enocom requested changes Dec 8, 2022

View reviewed changes

hessjcg force-pushed the onboard-docs branch from 8d8786e to e4a12af Compare December 12, 2022 17:41

enocom approved these changes Dec 12, 2022

View reviewed changes

hessjcg added 12 commits December 12, 2022 11:15

doc: put quickstart in the readme, move unnecessary dev steps out.

39c1d30

doc: add links for documents

ae265f2

doc: add link to intro presentation

b9b5398

doc: move the long quickstart guide into its own doc file.

396814b

chore: update make generate to ensure links to the installer match ve…

c3ea761

…rsion.txt

chore: code review comments

9e2936a

doc: add example configuration for tcp sockets

193a1cd

doc: move to examples/ and address code review comments

b89e8dc

chore: yaml formatting

eebdca9

chore: fix published installer and image paths to remove the '-dev'

f25d585

doc: update the readme to contain the same headings as cloud-sql-prox…

88f1dd5

…y readme.

fix: code review comments from eno

b6ba387

hessjcg force-pushed the onboard-docs branch from e4a12af to b6ba387 Compare December 12, 2022 18:15

hessjcg merged commit 891d6d8 into main Dec 12, 2022

hessjcg deleted the onboard-docs branch December 13, 2022 18:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: Add quickstart guide to README #126

doc: Add quickstart guide to README #126

hessjcg commented Dec 6, 2022

kurtisvg Dec 6, 2022

hessjcg Dec 6, 2022

kurtisvg Dec 6, 2022

hessjcg Dec 6, 2022

kurtisvg Dec 6, 2022

hessjcg Dec 6, 2022

kurtisvg Dec 6, 2022

hessjcg Dec 6, 2022

kurtisvg Dec 6, 2022

hessjcg Dec 6, 2022

kurtisvg Dec 6, 2022

hessjcg Dec 6, 2022

enocom Dec 8, 2022

hessjcg Dec 12, 2022

enocom Dec 8, 2022

hessjcg Dec 12, 2022

enocom Dec 8, 2022

hessjcg Dec 12, 2022

enocom Dec 8, 2022

hessjcg Dec 12, 2022

enocom Dec 8, 2022

hessjcg Dec 12, 2022

enocom Dec 8, 2022

hessjcg Dec 12, 2022

enocom Dec 8, 2022

hessjcg Dec 12, 2022

		Note that there are now two containers on the pods, while there is only one
		container on the deployment. The operator adds a second proxy container configured

		@@ -0,0 +1,131 @@
		# Quick Start -# Quick Start
		Follow the instructions in the Quick Start Guide for Cloud SQL: [Connect to Cloud SQL for PostgreSQL from Google Kubernetes Engine](https://cloud.google.com/sql/docs/postgres/connect-instance-kubernetes)

doc: Add quickstart guide to README #126

doc: Add quickstart guide to README #126

Conversation

hessjcg commented Dec 6, 2022

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

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