Add documentation about the new values in trigger auth in PostgreSQL Scaler #535

JorTurFer · 2021-09-21T21:57:01Z

Signed-off-by: jorturfer jorge_turrado@hotmail.es

Add documentation about the new values in trigger auth in PostgreSQL Scaler

Checklist

Commits are signed with Developer Certificate of Origin (DCO)

Related kedacore/keda#2114
Fixes kedacore/keda#2110

Signed-off-by: jorturfer <jorge_turrado@hotmail.es>

arschles · 2021-09-21T22:31:18Z

content/docs/2.5/scalers/postgresql.md

@@ -75,8 +75,12 @@ You can authenticate by using a password or store the password within the connec

 **Password Authentication:**

- `password` - Password for configured user to login to postgreSQL database
-variables.
+- `host:` Service URL to postgresql. Note that you should use a full svc URL as KEDA will need to contact postgresql from a different namespace


Suggested change

- `host:` Service URL to postgresql. Note that you should use a full svc URL as KEDA will need to contact postgresql from a different namespace

- `host:` Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace

Honestly, I have copied and pasted from the current "metadata definitions", so I will change both :)

Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Signed-off-by: jorturfer <jorge_turrado@hotmail.es>

tomkerkhove

Just needs a few improvements

tomkerkhove · 2021-09-22T05:06:00Z

content/docs/2.5/scalers/postgresql.md

@@ -22,7 +22,7 @@ Alternatively, a user can specify individual
 arguments (host, userName, password, etc.), and the scaler will form a connection string
 internally.

- `host:` Service URL to postgresql. Note that you should use a full svc URL as KEDA will need to contact postgresql from a different namespace
+- `host:` Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace.


Suggested change

- `host:` Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace.

- `host:` Service URL to PostgreSQL. Note that you should use a fully qualified URL (including the namespace) as KEDA will need to contact PostgreSQL from a different namespace.

tomkerkhove · 2021-09-22T05:06:33Z

content/docs/2.5/scalers/postgresql.md

@@ -22,7 +22,7 @@ Alternatively, a user can specify individual
 arguments (host, userName, password, etc.), and the scaler will form a connection string


Nit - Can you ensure all values use the PostgreSQL casing please given it's a product name?

Same for the <name>: where the : needs to be moved out.

Actually let's align with the majority of scalers:

host - The hostname of the MSSQL instance endpoint.

Do you mean using propery - description? Prometheus Scaler for example uses property: description also. WDYT if in another PR I review the scalers docs and unify the notation and style?
IMHO, unify the styles is out of the scope of this PR (but as I said, I'm opened to do it in another PR)

Yes, that notation.

A seperate PR would be awesome, if you are willing to do that of course.

Sure, I will do :)
Maybe I can open a discussion to decide which should be the correct way because we have several ways in the scalers

I have opened it
#539

tomkerkhove · 2021-09-22T05:06:44Z

content/docs/2.5/scalers/postgresql.md

@@ -75,8 +75,12 @@ You can authenticate by using a password or store the password within the connec

 **Password Authentication:**

- `password` - Password for configured user to login to postgreSQL database
-variables.
+- `host:` Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace.


tomkerkhove · 2021-09-22T05:06:54Z

content/docs/2.5/scalers/postgresql.md

-variables.
+- `host:` Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace.
+- `userName:` Username for postgresql user
+- `password` Password for configured user to login to postgreSQL database variables.


Suggested change

- `password` Password for configured user to login to postgreSQL database variables.

- `password`: Password for configured user to login to postgreSQL database.

tomkerkhove · 2021-09-22T05:07:16Z

content/docs/2.5/scalers/postgresql.md

+- `userName:` Username for postgresql user
+- `password` Password for configured user to login to postgreSQL database variables.
+- `port:` Postgresql port
+- `dbName:` Postgresql Database name


Suggested change

- `dbName:` Postgresql Database name

- `dbName`: Name of PostgreSQL database

tomkerkhove · 2021-09-22T05:07:24Z

content/docs/2.5/scalers/postgresql.md

+- `host:` Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace.
+- `userName:` Username for postgresql user
+- `password` Password for configured user to login to postgreSQL database variables.
+- `port:` Postgresql port


Suggested change

- `port:` Postgresql port

- `port`: Port of PostgreSQL database

tomkerkhove · 2021-09-22T05:07:38Z

content/docs/2.5/scalers/postgresql.md

- `password` - Password for configured user to login to postgreSQL database
-variables.
+- `host:` Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace.
+- `userName:` Username for postgresql user


Suggested change

- `userName:` Username for postgresql user

- `userName`: Username for postgresql user

tomkerkhove · 2021-09-22T05:07:45Z

content/docs/2.5/scalers/postgresql.md

@@ -75,8 +75,12 @@ You can authenticate by using a password or store the password within the connec

 **Password Authentication:**

- `password` - Password for configured user to login to postgreSQL database
-variables.
+- `host:` Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace.


Suggested change

- `host:` Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace.

- `host`: Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace.

tomkerkhove · 2021-09-22T05:08:25Z

content/docs/2.5/scalers/postgresql.md

+- `password` Password for configured user to login to postgreSQL database variables.
+- `port:` Postgresql port
+- `dbName:` Postgresql Database name
+- `sslmode:` SSL policy for communicating with database


Suggested change

- `sslmode:` SSL policy for communicating with database

- `sslmode`: SSL policy for communicating with database

Is the field sslmode or sslMode?

In the connection string is sslMode but our trigger variable is sslmode

Can you elaborate on that please? You mean trigger metadata uses sslMode but trigger authentication uses sslmode?

No, the other way around probably?

The required key in the connection string is sslMode, but inside the scaler we are looking for sslmode when we are parsing the metadata. Our key is sslmode, we take the value from the metadata key sslmode and place in the connection string key sslMode

Maybe we can look for both when we are parsing the scaler metadata and deprecate sslmode in favor of sslMode (the last one is how we have to place in connection string)

If sslMode is only in the connection string then we can just keep on using sslmode as we do today, no need to check for sslMode field then as well

okey, so basically we can let it as it is :)

Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com> Signed-off-by: Jorge Turrado <jorge.turrado@docplanner.com>

Add documentation about the new values in trigger auth

5879487

Signed-off-by: jorturfer <jorge_turrado@hotmail.es>

JorTurFer requested review from ahmelsayed, jeffhollan, tomkerkhove and zroubalik as code owners September 21, 2021 21:57

JorTurFer mentioned this pull request Sep 21, 2021

Add support to get connection data from Trigger Authorization in PostgreSQL Scaler kedacore/keda#2114

Merged

5 tasks

Fix typo

f35ebc9

Signed-off-by: jorturfer <jorge_turrado@hotmail.es>

arschles suggested changes Sep 21, 2021

View reviewed changes

Update doc

2073a68

Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Signed-off-by: jorturfer <jorge_turrado@hotmail.es>

tomkerkhove suggested changes Sep 22, 2021

View reviewed changes

Improves documentation

e26b9b0

Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com> Signed-off-by: Jorge Turrado <jorge.turrado@docplanner.com>

zroubalik requested a review from tomkerkhove October 4, 2021 08:25

zroubalik approved these changes Oct 4, 2021

View reviewed changes

zroubalik merged commit 468e258 into kedacore:master Oct 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation about the new values in trigger auth in PostgreSQL Scaler #535

Add documentation about the new values in trigger auth in PostgreSQL Scaler #535

JorTurFer commented Sep 21, 2021

arschles Sep 21, 2021

JorTurFer Sep 21, 2021

tomkerkhove left a comment

tomkerkhove Sep 22, 2021

tomkerkhove Sep 22, 2021

tomkerkhove Sep 22, 2021

tomkerkhove Sep 22, 2021

JorTurFer Sep 22, 2021 •

edited

Loading

tomkerkhove Sep 22, 2021

JorTurFer Sep 22, 2021 •

edited

Loading

JorTurFer Sep 22, 2021

tomkerkhove Sep 22, 2021

tomkerkhove Sep 22, 2021

tomkerkhove Sep 22, 2021

tomkerkhove Sep 22, 2021

tomkerkhove Sep 22, 2021

tomkerkhove Sep 22, 2021

tomkerkhove Sep 22, 2021

JorTurFer Sep 22, 2021

tomkerkhove Sep 22, 2021

tomkerkhove Sep 22, 2021

JorTurFer Sep 22, 2021

JorTurFer Sep 22, 2021

tomkerkhove Sep 22, 2021

JorTurFer Sep 22, 2021

	- `host:` Service URL to postgresql. Note that you should use a full svc URL as KEDA will need to contact postgresql from a different namespace
	- `host:` Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace

		@@ -22,7 +22,7 @@ Alternatively, a user can specify individual
		arguments (host, userName, password, etc.), and the scaler will form a connection string

	- `password` Password for configured user to login to postgreSQL database variables.
	- `password`: Password for configured user to login to postgreSQL database.

	- `dbName:` Postgresql Database name
	- `dbName`: Name of PostgreSQL database

	- `port:` Postgresql port
	- `port`: Port of PostgreSQL database

	- `userName:` Username for postgresql user
	- `userName`: Username for postgresql user

	- `host:` Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace.
	- `host`: Service URL to postgresql. Note that you should use a fully qualified URL -- including the namespace -- as KEDA will need to contact postgresql from a different namespace.

	- `sslmode:` SSL policy for communicating with database
	- `sslmode`: SSL policy for communicating with database

Add documentation about the new values in trigger auth in PostgreSQL Scaler #535

Add documentation about the new values in trigger auth in PostgreSQL Scaler #535

Conversation

JorTurFer commented Sep 21, 2021

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomkerkhove left a 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

JorTurFer Sep 22, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JorTurFer Sep 22, 2021 • 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

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

JorTurFer Sep 22, 2021 •

edited

Loading

JorTurFer Sep 22, 2021 •

edited

Loading