Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 4 commits into from
Oct 4, 2021
Merged

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

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5879487
Add documentation about the new values in trigger auth
JorTurFer Sep 21, 2021
f35ebc9
Fix typo
JorTurFer Sep 21, 2021
2073a68
Update doc
JorTurFer Sep 21, 2021
e26b9b0
Improves documentation
Sep 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions content/docs/2.5/scalers/postgresql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

- `userName:` Username for postgresql user
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

- `port:` Postgresql port
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

- `dbName:` Postgresql Database name
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

- `sslmode:` SSL policy for communicating with database
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Is the field sslmode or sslMode?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, the other way around probably?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


### Example

Expand Down