Add exposed DSN option for postgres:info command #162

nicolas-brousse · 2018-11-20T17:09:07Z

I love to use pgcli on my laptop. I use it to log on my heroku databases (pgcli $(heroku config:get DATABASE_URL)). And I would like to be able to do the same on dokku, so I created this PR.

I tested it on one dokku instance and it works correclty. And I'm able to do the following now.

$ pgcli $(ssh [email protected] postgres:info postgres-database --external-dsn)

I'm new in dokku usage, so I don't know all your conventions. Maybe this could not be done for some reason, or you want I do some changes. Let me know 🙂

joshmanders · 2018-11-20T20:04:40Z

ssh [email protected] config:get <app> DATABASE_URL

Should work the same way.

nicolas-brousse · 2018-11-20T21:37:49Z

$ ssh [email protected] config:get <app> DATABASE_URL

Must returns the same value as ssh [email protected] postgres:info postgres-database --dsn does. In my case it returns the internal DSN. So it's not really the same.

josegonzalez · 2018-11-21T17:48:30Z

functions

+  local PORTS=($(cat "$PORT_FILE"))
+  local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
+  local DATABASE_NAME="$(get_database_name "$SERVICE")"
+  local GLOBAL_VHOST_PATH="$DOKKU_ROOT/VHOST"


What happens when this file does not exist?

Good question, I missed it. Thanks for the point

I did some changes here too.

josegonzalez · 2018-11-21T17:48:44Z

functions

+  local PORT_FILE="$SERVICE_ROOT/PORT"
+  [[ ! -f $PORT_FILE ]] && echo '-' && return 0
+
+  local PORTS=($(cat "$PORT_FILE"))


This port may not be exposed to the public, so this external dsn would fail to work.

What do you mean by "This port may not be exposed to the public"?

You mean because of a firewall for example?

The port is by default only on the internal ip address. You'd need to call SERVICE:expose on the service (with the port you want to map it to specified) and only then would this code work.

Yes, maybe I missed some explanation. I currently run ssh [email protected] postgres:expose postgres-database before pgcli $(ssh [email protected] postgres:info postgres-database --external-dsn). If not External dsn returns - as Exposed ports do.

$ ssh [email protected] postgres:info postgres-database =====> Container Information Config dir: /var/lib/dokku/services/postgres/postgres-database/config Data dir: /var/lib/dokku/services/postgres/postgres-database/data Dsn: postgres://postgres:xxxxxxxxxxxx@dokku-postgres-postgres-database:5432/postgres_database External dsn: - Exposed ports: - Id: 9dc918204b5fb0a4b8848a71 Internal ip: 172.17.0.3 Links: postgres-database Service root: /var/lib/dokku/services/postgres/postgres-database Status: running Version: postgres:10.4 $ ssh [email protected] postgres:expose postgres-database $ ssh [email protected] postgres:info postgres-database =====> Container Information Config dir: /var/lib/dokku/services/postgres/postgres-database/config Data dir: /var/lib/dokku/services/postgres/postgres-database/data Dsn: postgres://postgres:xxxxxxxxxxxx@dokku-postgres-postgres-database:5432/postgres_database External dsn: postgres://postgres:[email protected]:28804/postgres_database Exposed ports: 5432->28804 Id: 9dc918204b5fb0a4b8848a71 Internal ip: 172.17.0.3 Links: postgres-database Service root: /var/lib/dokku/services/postgres/postgres-database Status: running Version: postgres:10.4

Maybe I have to update the README for more explanation.

Right I'm just concerned that if the db is not exposed, then people will get confused and start filing issues about how this doesn't work.

You're right, I'll work on updating README and maybe add precision on command help info about the option.

I do some changes on README and flag description.

Should be empty if the service is not exposed.

External dsn: already returns - if the service is not exposed.

Does this fine for you?

nicolas-brousse · 2018-11-29T22:15:07Z

Also I'm not sure about external-dsn as flag name. Should it be exposed-dsn or something else?

josegonzalez · 2018-12-01T18:47:40Z

exposed-dsn sounds fine.

nicolas-brousse · 2018-12-01T18:48:44Z

I'll rename external-dsn to exposed-dsn so.

nicolas-brousse · 2020-03-19T14:22:58Z

Hey josegonzalez. Are you still interested on this changes? I could found time in following weeks to end the work 🙂

josegonzalez · 2020-03-19T15:54:12Z

Yes but I'd like this to be in the common-functions, so therefore generic so that we could do this to each database plugin.

nicolas-brousse · 2020-03-19T22:16:09Z

The thing is like for service_url (that is in functions file too) we do not know the user that should be use to generate the URI.

dokku-postgres/functions

Line 159 in 89f080c

echo "$PLUGIN_SCHEME://postgres:$PASSWORD@$SERVICE_DNS_HOSTNAME:${PLUGIN_DATASTORE_PORTS[0]}/$DATABASE_NAME"
dokku-postgres/functions

Line 168 in 3cb5b59

echo "$PLUGIN_SCHEME://postgres:$PASSWORD@${GLOBAL_VHOSTS[0]}:${PORTS[0]}/$DATABASE_NAME"

Do we need to have something like for redis plugin?

https://github.com/dokku/dokku-redis/blob/fb1b189aeac0411226f66e2099560fe2061601e9/functions#L158

Should I move both service_url and service_exposed_url inside common-functions?

josegonzalez · 2020-03-20T14:52:08Z

@nicolas-brousse do you mean hostname, not user?

nicolas-brousse · 2020-03-20T14:54:23Z

A user that is part of the hostname yes schema://user:password@host.

The connection user (postgres) is not currently contained in a variable.

josegonzalez · 2020-03-20T14:56:14Z

Ah I see what you mean. In that case, ignore my comment.

Can you rebase this and provide the same PR to the other database plugins?

nicolas-brousse · 2020-03-20T14:58:14Z

Yes sure.

But just to know, I noticed that for redis plugin, there is the variable $SERVICE used. Do you think we could apply the same here?

https://github.com/dokku/dokku-redis/blob/fb1b189aeac0411226f66e2099560fe2061601e9/functions#L154-L159

josegonzalez · 2020-03-20T15:07:33Z

Not sure thats always valid for all plugins.

nicolas-brousse · 2020-03-20T15:14:40Z

Not sure either. I'll just rebase then, and do the same in other database plugins 🙂

nicolas-brousse changed the title ~~Add external DSN option for postgres:info~~ Add external DSN option for postgres:info command Nov 20, 2018

josegonzalez reviewed Nov 21, 2018

View reviewed changes

nicolas-brousse force-pushed the add-external-dsn-option-for-postgres-info-cmd branch 2 times, most recently from a3bffba to 3879ff9 Compare November 29, 2018 22:09

nicolas-brousse force-pushed the add-external-dsn-option-for-postgres-info-cmd branch from 3879ff9 to 5f2a81d Compare December 1, 2018 18:53

nicolas-brousse changed the title ~~Add external DSN option for postgres:info command~~ Add exposed DSN option for postgres:info command Dec 1, 2018

nicolas-brousse force-pushed the add-external-dsn-option-for-postgres-info-cmd branch 2 times, most recently from df40c30 to 3cb5b59 Compare December 1, 2018 19:38

Add --exposed-dsn option for postgres:info

f617bdb

nicolas-brousse force-pushed the add-external-dsn-option-for-postgres-info-cmd branch from 3cb5b59 to f617bdb Compare March 21, 2020 23:15

This was referenced Mar 21, 2020

Add --exposed-dsn option for redis:info dokku/dokku-redis#147

Closed

Add --exposed-dsn option for mysql:info dokku/dokku-mysql#115

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add exposed DSN option for postgres:info command #162

Add exposed DSN option for postgres:info command #162

nicolas-brousse commented Nov 20, 2018

joshmanders commented Nov 20, 2018 •

edited

Loading

nicolas-brousse commented Nov 20, 2018

josegonzalez Nov 21, 2018

nicolas-brousse Nov 22, 2018

nicolas-brousse Nov 29, 2018

josegonzalez Nov 21, 2018

nicolas-brousse Nov 22, 2018

josegonzalez Nov 26, 2018

nicolas-brousse Nov 29, 2018

josegonzalez Nov 29, 2018

nicolas-brousse Nov 29, 2018

nicolas-brousse Nov 29, 2018

josegonzalez Dec 1, 2018

nicolas-brousse Dec 1, 2018

nicolas-brousse Jan 23, 2019

nicolas-brousse commented Nov 29, 2018

josegonzalez commented Dec 1, 2018

nicolas-brousse commented Dec 1, 2018

nicolas-brousse commented Mar 19, 2020

josegonzalez commented Mar 19, 2020 •

edited

Loading

nicolas-brousse commented Mar 19, 2020 •

edited

Loading

josegonzalez commented Mar 20, 2020

nicolas-brousse commented Mar 20, 2020

josegonzalez commented Mar 20, 2020

nicolas-brousse commented Mar 20, 2020

josegonzalez commented Mar 20, 2020

nicolas-brousse commented Mar 20, 2020

Add exposed DSN option for postgres:info command #162

Are you sure you want to change the base?

Add exposed DSN option for postgres:info command #162

Conversation

nicolas-brousse commented Nov 20, 2018

joshmanders commented Nov 20, 2018 • edited Loading

nicolas-brousse commented Nov 20, 2018

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

nicolas-brousse commented Nov 29, 2018

josegonzalez commented Dec 1, 2018

nicolas-brousse commented Dec 1, 2018

nicolas-brousse commented Mar 19, 2020

josegonzalez commented Mar 19, 2020 • edited Loading

nicolas-brousse commented Mar 19, 2020 • edited Loading

josegonzalez commented Mar 20, 2020

nicolas-brousse commented Mar 20, 2020

josegonzalez commented Mar 20, 2020

nicolas-brousse commented Mar 20, 2020

josegonzalez commented Mar 20, 2020

nicolas-brousse commented Mar 20, 2020

joshmanders commented Nov 20, 2018 •

edited

Loading

josegonzalez commented Mar 19, 2020 •

edited

Loading

nicolas-brousse commented Mar 19, 2020 •

edited

Loading