Add exposed DSN option for postgres:info command

[nicolas-brousse]

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 dokku@dokku.me 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]

ssh dokku@dokku.me config:get <app> DATABASE_URL

Should work the same way.

[nicolas-brousse]

$ ssh dokku@dokku.me config:get <app> DATABASE_URL

Must returns the same value as ssh dokku@dokku.me postgres:info postgres-database --dsn does. In my case it returns the internal DSN. So it's not really the same.

[josegonzalez]

What happens when this file does not exist?

[nicolas-brousse]

Good question, I missed it. Thanks for the point

[nicolas-brousse]

I did some changes here too.

[josegonzalez]

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

[nicolas-brousse]

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

You mean because of a firewall for example?

[josegonzalez]

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.

[nicolas-brousse]

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

$ ssh dokku@dokku.me 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 dokku@dokku.me postgres:expose postgres-database
$ ssh dokku@dokku.me 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:xxxxxxxxxxxx@dokku.me: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.

[josegonzalez]

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.

[nicolas-brousse]

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

[nicolas-brousse]

I do some changes on README and flag description.

[josegonzalez]

Should be empty if the service is not exposed.

[nicolas-brousse]

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

[nicolas-brousse]

Does this fine for you?

[nicolas-brousse]

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

[josegonzalez]

exposed-dsn sounds fine.

[nicolas-brousse]

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

[nicolas-brousse]

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

[josegonzalez]

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]

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]

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

[nicolas-brousse]

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]

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]

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]

Not sure thats always valid for all plugins.

[nicolas-brousse]

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