Conversation
|
|
||
| 3. Modify the dashboard application so that it takes its configuration from environment variables and expects a PostgreSQL database instead of an SQLite database: | ||
|
|
||
| ``` { name=modify-dashboard } |
There was a problem hiding this comment.
I'm using { name=foo } on command blocks that are to be run in the multipass VM (after cloning the repo). That's so that the runme tool can extract the command blocks, which makes it easier to use this README as the basis for demos.
| juju run dashboard/0 load-sample-data | ||
| ``` | ||
|
|
||
| This uses a Juju "action" to run [manage.py](./dashboard/manage.py) inside the dashboard application's container. For technical details, see [TODO: doc in progress]. |
There was a problem hiding this comment.
I'll link to Erin's docs about adding custom actions, after that's published. See canonical/charmcraft#2256.
|
|
||
| ``` { name=deploy-dashboard } | ||
| cd ~/dashboard | ||
| rockcraft.skopeo --insecure-policy copy --dest-tls-verify=false \ |
There was a problem hiding this comment.
I've put the rockcraft.skopeo step here for a couple of reasons:
- I wanted to avoid the "Create a container image for the application" section having a long wait in the middle (from packing the rock).
- Deploying the charm pulls the image from the registry, so it feels natural to introduce the registry close to where it's used.
erinecon
left a comment
erinecon
left a comment
There was a problem hiding this comment.
README instructions look good to me!
| ``` | ||
| cd | ||
| git clone https://github.com/canonical/dashboard.git | ||
| ``` |
There was a problem hiding this comment.
For my understanding: Why do you have to cd before you run git clone?
There was a problem hiding this comment.
This switches to the home directory of the VM, so that we can assume the cloned repo is at ~/dashboard later in the instructions.
| > ``` | ||
| > Packed dashboard_0.7_amd64.rock | ||
| > ``` |
There was a problem hiding this comment.
Nitpick: Will the user see this output, or (assuming they're running for the first time) Packed dashboard_0.1_amd64.rock?
I would either rephrase the line above to say When you return, you should see something similar to the following output:, or replace 0.7 with 0.1.
There was a problem hiding this comment.
They should see this exact output with 0.7, because the version number in this repo's rockcraft.yaml is 0.7 (here)
There was a problem hiding this comment.
Ah fair enough, I probably should have looked in the rockcraft.yaml file to confirm 😅 thanks!
|
Merging - thanks a lot for the reviews! |
3 participants
This PR completes the "Deploy the dashboard on your machine" section of the README. My goal with this section is for the reader to be able to build the dashboard on their machine and see it working. It's not intended to fully simulate a production deployment - e.g., no ingress, as that's not required for the dashboard to run. I'm thinking that a later section can handle production concerns.