Skip to content

Commit

Permalink
docs: add more maintainer/privilege info to maintainers doc, buildkit…
Browse files Browse the repository at this point in the history
…e setup (#5584) [skip ci]

Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>
  • Loading branch information
rfay and stasadev committed Nov 28, 2023
1 parent d55d767 commit 5e63fb1
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 3 deletions.
7 changes: 6 additions & 1 deletion docs/content/developers/buildkite-testmachine-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,4 +170,9 @@ We are using [Buildkite](https://buildkite.com/ddev) for Windows and macOS testi
26. Run `bash ~/workspace/ddev/.buildkite/testbot_maintenance.sh`.
27. Run `bash ~/workspace/ddev/.buildkite/sanetestbot.sh` to check your work.
28. The `testbot` user's ssh account is used for monitoring, so `ssh-keygen` and then add the public key `id_testbot` from 1Password to `~/.ssh/authorized_keys` and `chmod 600 ~/.ssh/authorized_keys`.
29. Add the new machine to Icinga by copying an existing Icinga service to the new one. This is done in **Icinga Director****Services****Single Services****Select a Service****Clone****Deploy**.
29. Add the new machine to Icinga by copying an existing Icinga service to the new one. This is done in **Icinga Director****Services****Single Services****Select a Service****Clone****Deploy**. The new service has to have `by-ssh-address` set to the name of the test runner, and that address needs to be added to `pi.ddev.site`'s `/etc/hosts` file.
30. If `zsh` is the shell configured, add `/etc/zshenv` so that `/usr/local/bin/docker` will be picked up:

```bash
PATH=$PATH:/usr/local/bin:/opt/homebrew/bin
```
14 changes: 12 additions & 2 deletions docs/content/developers/maintainers.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ Not all maintainers can do all these things at any given time, but these are the
* [DDEV blog](https://ddev.com/blog)
* 1Password passwords and tokens: Maintainers should be added to the DDEV team in 1Password. This gives access to the DDEV team vault, which has tokens and passwords that are needed for various things. Please try to maintain things like tokens in there.

## Maintainer Training Outline

## Privileges Required for Maintainers

Most privileges should be granted per-developer as separate accounts. In general, we don't want to share a common login. So for example, instead of sharing a login to [developer.apple.com](https://developer.apple.com) or [buildkite.com](https://buildkite.com/ddev) each maintainer should have their own login.
Expand All @@ -44,6 +42,15 @@ There are cases like access to hosting provider integrations that have essential

* **GitHub**: Maintainers should usually be added to the [DDEV organization](https://github.com/orgs/ddev/people), usually was "owner", but lesser privileges are possible, and some maintainers may want only access to the DDEV project, etc.
* **Buildkite**: Maintainers should be added to the [DDEV Buildkite organization](https://buildkite.com/organizations/ddev/users) with "maintainer" privileges. This gives access to the Buildkite pipelines and the ability to add new pipelines. Do not require "SSO" or people won't be able to get in.
* **Chrome Remote Desktop**: This is the test runner login ("DDEV buildkite test-runners - remotedesktop.google.com") from 1Password, but it will need to be authorized via 2FA or a backup code from 1Password.
* **CircleCI**: Maintainers automatically have some access via their GitHub team membership, but should probably get more.
* **developer.apple.com**: Add to the DDEV team there so certificates can be managed.
* **hub.docker.com**: Add user to owners team in DDEV org.
* **Chocolatey**: Add user to [Manage maintainers](https://community.chocolatey.org/packages/ddev/1.22.5/ManagePackageOwners).
* **Icinga monitoring system**: This is documented in [maintainer-info](https://github.com/ddev/maintainer-info).
* **Discord**: Make admin in Discord.
* **Twitter (X)**: Posting is enabled by login in 1Password.
* **Mastodon**: Posting is enabled by login in 1Password.
* **Zoho Mail** is how `ddev.com` mail is routed; currently only Randy has an account, but we should consider adding others and making sure that more than one person can maintain it.
* **Zoho CRM** is how we track contacts and send monthly emails or announcements. People involved in marketing will want to have access to this, but it will cost for additional users.
* **[1Password](https://1password.com/)**. Maintainers should be added to the DDEV team in 1Password. This gives access to the DDEV team vault, which has tokens and passwords that are needed for various things. Please try to maintain things like tokens in there.
Expand All @@ -55,9 +62,12 @@ There are cases like access to hosting provider integrations that have essential
* SSH (and sudo) access to `newmonitor.thefays.us`
* **[developer.apple.com](https://developer.apple.com)** - Maintainers should be added to the DDEV team in the Apple Developer program, so that they can create new certificates.
* **SSH access to newmonitor.thefays.us**.
* **Account on pi.ddev.site**.
* **Notifications from newmonitor.thefays.us**.
* **Web access to newmonitor.thefays.us**.
* **SSH access to behind-firewall monitoring proxy**.
* **Amplitude**: Invite new user at [team management](https://analytics.amplitude.com/ddev/settings/team).
* **Stack Overflow**: Follow the [ddev tag on Stack Overflow](https://stackoverflow.com/questions/tagged/ddev) and answer or comment on questions there when possible.

## Newmonitor.thefays.us use and maintenance

Expand Down
3 changes: 3 additions & 0 deletions markdown-link-check.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@
},
{
"pattern": "^https://newmonitor.thefays.us/icingaweb2"
},
{
"pattern": "^https://analytics.amplitude.com"
}
],
"httpHeaders": [
Expand Down

0 comments on commit 5e63fb1

Please sign in to comment.