Skip to content

Commit

Permalink
Update docs (#4)
Browse files Browse the repository at this point in the history
* Add missing discord for Paul

* Add more readme dogs
  • Loading branch information
criccomini authored Nov 19, 2024
1 parent 79e702e commit 9129ea1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,34 @@
# slatedb-pulumi

Pulumi scripts to manage SlateDB committer access to various infrastructure resources.
Pulumi scripts to manage SlateDB committer access to:

## Pulumi State
- Github
- Discord
- Crates.io

The Pulumi state is stored in Pulumi Cloud. The state is stored in the `slatedb` organization. The state is stored in the `slatedb-pulumi/prod` stack.
Users must still be manually added to [SlateDB's Pulumi cloud organization](https://app.pulumi.com/slatedb/members). The Pulumi state is stored in Pulumi Cloud. The state is stored in the `slatedb` organization. The state is stored in the `slatedb-pulumi/prod` stack.

## Environment Variables

The following environment variables must be set:

### `PULUMI_ACCESS_TOKEN`

A Pulumi Cloud access token is used to authenticate with Pulumi Cloud. The Pulumi access token can be created in the [organization access tokens](https://app.pulumi.com/slatedb/settings/org-tokens) page.

### `CARGO_REGISTRY_TOKEN`

Can be created from https://crates.io/settings/tokens.

### `DISCORD_TOKEN`

Can be created from https://discord.com/developers.
Can be created from https://discord.com/developers. The Github actions in this repository use [@criccomini](https://github/criccomini)'s Discord bot. If you ever need to create your own Discord bot, you can do so by following these instructions:

1. Create a Discord bot. (follow [these inscrutions](https://discordpy.readthedocs.io/en/stable/discord.html))
2. Add the discord bot to SlateDB with the appropriate permissions. (follow [these instructions](https://stackoverflow.com/questions/50942405/discord-js-unknown-guild-when-removing-all-roles-from-a-user))

### `GITHUB_TOKEN`

Can be created from https://github.com/settings/tokens?type=beta.

Github will fill this environment variable in automatically when you run a workflow. Make sure the workflow has the appropriate permissions to grant users ownership of the `slatedb` Github orgnaization and its repositories.
The Github actions in this repository use [@criccomini](https://github/criccomini)'s personal access token to grant users access to the `slatedb` Github organization. (Github does not allow the use of Github tokens in Github actions to grant users access to an organization.)
2 changes: 1 addition & 1 deletion __main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class Maintainer:
# Maintainer(
# name="Paul Butler",
# github="paulgb",
# discord="",
# discord="534035699565854720",
# ),
# Maintainer(
# name="Li Yazhou",
Expand Down

0 comments on commit 9129ea1

Please sign in to comment.