Skip to content

Fix typo in King Arthur The Terrible environment variables #619

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typo in King Arthur The Terrible environment variables #619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
58 changes: 29 additions & 29 deletions kubernetes/namespaces/bots/king-arthur/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,40 +8,40 @@ This deployment expects a number of secrets and environment variables to exist i
### Core
These environment variables are required to start the bot

| Environment | Description | Required/Default |
| ------------------------------------- | ------------------------------------------------------------ | ------------------------- |
| KING_ARTHUR_TOKEN | The bot token to authorize with Discord | Required |
| KING_ARTHUR_PREFIXES | The list of prefixes to listen to commands | `("arthur ", "M-x ")` |
| KING_ARTHUR_DEVOPS_ROLE | The Discord role that is allowed to run King Arthur commands | 409416496733880320 |
| KING_ARTHUR_GUILD_ID | The guild the bot should interact with | 267624335836053506 |
| KING_ARTHUR_DEVOPS_CHANNEL_ID | The devops Discord channel | 675756741417369640 |
| KING_ARTHUR_SENTRY_DSN | Where to send sentry alerts | "" |
| Environment | Description | Required/Default |
| -------------------------------------------------- | ------------------------------------------------------------ | ------------------------- |
| KING_ARTHUR_THE_TERRIBLE_TOKEN | The bot token to authorize with Discord | Required |
| KING_ARTHUR_THE_TERRIBLE_PREFIXES | The list of prefixes to listen to commands | `("arthur ", "M-x ")` |
| KING_ARTHUR_THE_TERRIBLE_DEVOPS_ROLE | The Discord role that is allowed to run King Arthur commands | 409416496733880320 |
| KING_ARTHUR_THE_TERRIBLE_GUILD_ID | The guild the bot should interact with | 267624335836053506 |
| KING_ARTHUR_THE_TERRIBLE_DEVOPS_CHANNEL_ID | The devops Discord channel | 675756741417369640 |
| KING_ARTHUR_THE_TERRIBLE_SENTRY_DSN | Where to send sentry alerts | "" |

### API integrations
These environment variables are required to work on the relevant cog.

| Environment | Relevant cog | Description | Required/Default |
| ------------------------------------- | --------------------- | ------------------------------------------------------------------------- | ------------------------- |
| KING_ARTHUR_CLOUDFLARE_TOKEN | Zones | A token for the Cloudflare API used for the Cloudflare commands in Arthur | Required |
| KING_ARTHUR_GITHUB_ORG | GrafanaGitHubTeamSync | The github organisation to fetch teams from | python-discord |
| KING_ARTHUR_GITHUB_TOKEN | GrafanaGitHubTeamSync | The github token used to fetch teams to populate grafana | Required |
| KING_ARTHUR_GRAFANA_URL | GrafanaGitHubTeamSync | The URL to the grafana instance to manage teams | https://grafana.pydis.wtf |
| KING_ARTHUR_GRAFANA_TOKEN | GrafanaGitHubTeamSync | The grafana token used to sync teams with github | Required |
| KING_ARTHUR_YOUTUBE_API_KEY | Motivation | The YouTube API key to fetch missions with | Required |
| Environment | Relevant cog | Description | Required/Default |
| -------------------------------------------------- | --------------------- | ------------------------------------------------------------------------- | ------------------------- |
| KING_ARTHUR_THE_TERRIBLE_CLOUDFLARE_TOKEN | Zones | A token for the Cloudflare API used for the Cloudflare commands in Arthur | Required |
| KING_ARTHUR_THE_TERRIBLE_GITHUB_ORG | GrafanaGitHubTeamSync | The github organisation to fetch teams from | python-discord |
| KING_ARTHUR_THE_TERRIBLE_GITHUB_TOKEN | GrafanaGitHubTeamSync | The github token used to fetch teams to populate grafana | Required |
| KING_ARTHUR_THE_TERRIBLE_GRAFANA_URL | GrafanaGitHubTeamSync | The URL to the grafana instance to manage teams | https://grafana.pydis.wtf |
| KING_ARTHUR_THE_TERRIBLE_GRAFANA_TOKEN | GrafanaGitHubTeamSync | The grafana token used to sync teams with github | Required |
| KING_ARTHUR_THE_TERRIBLE_YOUTUBE_API_KEY | Motivation | The YouTube API key to fetch missions with | Required |

### LDAP & Directory integrations
The environment variables are required to work with the LDAP/FreeIPA system.

| Environment | Description | Required/Default |
| ------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| KING_ARTHUR_ENABLE_LDAP | Whether the LDAP cog should be started | False |
| KING_ARTHUR_LDAP_BOOTSTRAP_CHANNEL_ID | Channel to send the LDAP account reset message | 1266358923875586160 |
| KING_ARTHUR_LDAP_HOST | The FQDN of the host running LDAP | Required |
| KING_ARTHUR_LDAP_BIND_USER | The LDAP user to use when making requests | uid=kingarthur,cn=users,cn=accounts,dc=box,dc=pydis,dc=wtf |
| KING_ARTHUR_LDAP_BIND_PASSWORD | The password for the above user | Required |
| KING_ARTHUR_LDAP_BASE_DN | The base distinguished name to use for requests to LDAP | dc=box,dc=pydis,dc=wtf |
| KING_ARTHUR_LDAP_CERTIFICATE_LOCATION | The location of the self signed cert to send with requests | Required |
| KING_ARTHUR_KEYCLOAK_ADDRESS | The URL to the keycloak address to make requests to | Required |
| KING_ARTHUR_KEYCLOAK_USERNAME | The username of the keycloak user to make requests with | kingarthur |
| KING_ARTHUR_KEYCLOAK_PASSWORD | The password of the keycloak user to make requests with | Required |
| KING_ARTHUR_KEYCLOAK_USER_REALM | The keycloak realm to make requests to | pydis |
| Environment | Description | Required/Default |
| -------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| KING_ARTHUR_THE_TERRIBLE_ENABLE_LDAP | Whether the LDAP cog should be started | False |
| KING_ARTHUR_THE_TERRIBLE_LDAP_BOOTSTRAP_CHANNEL_ID | Channel to send the LDAP account reset message | 1266358923875586160 |
| KING_ARTHUR_THE_TERRIBLE_LDAP_HOST | The FQDN of the host running LDAP | Required |
| KING_ARTHUR_THE_TERRIBLE_LDAP_BIND_USER | The LDAP user to use when making requests | uid=kingarthur,cn=users,cn=accounts,dc=box,dc=pydis,dc=wtf |
| KING_ARTHUR_THE_TERRIBLE_LDAP_BIND_PASSWORD | The password for the above user | Required |
| KING_ARTHUR_THE_TERRIBLE_LDAP_BASE_DN | The base distinguished name to use for requests to LDAP | dc=box,dc=pydis,dc=wtf |
| KING_ARTHUR_THE_TERRIBLE_LDAP_CERTIFICATE_LOCATION | The location of the self signed cert to send with requests | Required |
| KING_ARTHUR_THE_TERRIBLE_KEYCLOAK_ADDRESS | The URL to the keycloak address to make requests to | Required |
| KING_ARTHUR_THE_TERRIBLE_KEYCLOAK_USERNAME | The username of the keycloak user to make requests with | kingarthur |
| KING_ARTHUR_THE_TERRIBLE_KEYCLOAK_PASSWORD | The password of the keycloak user to make requests with | Required |
| KING_ARTHUR_THE_TERRIBLE_KEYCLOAK_USER_REALM | The keycloak realm to make requests to | pydis |
Binary file modified kubernetes/namespaces/bots/king-arthur/secrets.yaml
View file
Open in desktop
Binary file not shown.