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.

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 basic deployment instructions (Fixes #47) #48

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
40 changes: 40 additions & 0 deletions docs/deploying.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
=================
Deploying Changes
=================

Ensure you're setup by following the setup instructions available `here. <https://thunderbird.github.io/pulumi/getting-started.html>`_

Additionally you'll also need a login token from pulumi cloud. The pulumi cloud account is located in the Services 1password account.

Choose a reason for hiding this comment

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

If you don't have a token, you can do a browser auth flow where you click a link in the CLI, auth with the service account found in 1Pass, and it redirects you back to the terminal.


Before Running
--------------

Make sure to cd into ``pulumi`` and install the requirements.txt file via ``pip install -r requirements.txt``.

Everytime you run either ``pulumi up`` or `pulumi preview`` pulumi will ask you which stack you want to run.

Choose a reason for hiding this comment

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

Alternately, run a pulumi stack select $stack and it will remember your selection. You'll also need to run pulumi login which is where you'd provide your token/password/do browser auth.


Previewing Changes
------------------

To preview changes showing the diff of the update run the following:

.. code-block:: bash

pulumu preview --diff

No actual changes will be pushed up, this command should be safe to run at anytime.

Deploying Changes
-----------------

.. code-block:: bash

pulumu up --diff

Choose a reason for hiding this comment

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

s/pulumu/pulumi/g


Verifying Changes
-----------------

Once you've successfully deployed your json changes you can verify that they're live by going to:

- Stage: https://notifications-stage.thunderbird.net/2.0/notifications.json
- Prod: https://notifications.thunderbird.net/2.0/notifications.json
Loading