diff options
Diffstat (limited to 'doc/development/chatops_on_gitlabcom.md')
| -rw-r--r-- | doc/development/chatops_on_gitlabcom.md | 53 |
1 files changed, 44 insertions, 9 deletions
diff --git a/doc/development/chatops_on_gitlabcom.md b/doc/development/chatops_on_gitlabcom.md index c64766af589..a2a0005f7cb 100644 --- a/doc/development/chatops_on_gitlabcom.md +++ b/doc/development/chatops_on_gitlabcom.md @@ -1,31 +1,66 @@ --- stage: Configure group: Configure -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Chatops on GitLab.com +# ChatOps on GitLab.com ChatOps on GitLab.com allows GitLab team members to run various automation tasks on GitLab.com using Slack. ## Requesting access -GitLab team-members may need access to Chatops on GitLab.com for administration +GitLab team-members may need access to ChatOps on GitLab.com for administration tasks such as: - Configuring feature flags. - Running `EXPLAIN` queries against the GitLab.com production replica. - Get deployment status of all of our environments or for a specific commit: `/chatops run auto_deploy status [commit_sha]` -To request access to Chatops on GitLab.com: +To request access to ChatOps on GitLab.com: -1. Log into <https://ops.gitlab.net/users/sign_in> **using the same username** as for GitLab.com (you may have to rename it). - 1. You could also use the "Sign in with" Google button to sign in, with your GitLab.com email address. -1. Ask one of your team members to add you to the `chatops` project in Ops. They can do it by running `/chatops run member add <username> gitlab-com/chatops --ops` command in the `#chat-ops-test` Slack channel. -1. If you had to change your username for GitLab.com on the first step, make sure [to reflect this information](https://gitlab.com/gitlab-com/www-gitlab-com#adding-yourself-to-the-team-page) on [the team page](https://about.gitlab.com/company/team/). +1. Sign in to [Internal GitLab for Operations](https://ops.gitlab.net/users/sign_in) + with one of the following methods: + + - The same username you use on GitLab.com. You may have to choose a different + username later. + - Clicking the **Sign in with Google** button to sign in with your GitLab.com email address. + +1. Confirm that your username in [Internal GitLab for Operations](https://ops.gitlab.net/) + is the same as your username in [GitLab.com](https://gitlab.com/). If the usernames + don't match, update the username at [Internal GitLab for Operations](https://ops.gitlab.net/). + +1. Comment in your onboarding issue, and tag your onboarding buddy and your manager. + Request they add you to the `ops` ChatOps project by running this command + in the `#chat-ops-test` Slack channel, replacing `<username>` with your username: + `/chatops run member add <username> gitlab-com/chatops --ops` + + <!-- vale gitlab.FirstPerson = NO --> + + > Hi `__BUDDY_HANDLE__` and `__MANAGER_HANDLE__`, could you please add me to + > the ChatOps project in Ops by running this command: + > `/chatops run member add <username> gitlab-com/chatops --ops` in the + > `#chat-ops-test` Slack channel? Thanks in advance. + + <!-- vale gitlab.FirstPerson = YES --> + +1. Ensure you've set up two-factor authentication. +1. After you're added to the ChatOps project, run this command to check your user + status and ensure you can execute commands in the `#chat-ops-test` Slack channel: + + ```plaintext + /chatops run user find <username> + ``` + + The bot guides you through the process of allowing your user to execute + commands in the `#chat-ops-test` Slack channel. + +1. If you had to change your username for GitLab.com on the first step, make sure + [to reflect this information](https://gitlab.com/gitlab-com/www-gitlab-com#adding-yourself-to-the-team-page) + on [the team page](https://about.gitlab.com/company/team/). ## See also -- [Chatops Usage](../ci/chatops/README.md) +- [ChatOps Usage](../ci/chatops/README.md) - [Understanding EXPLAIN plans](understanding_explain_plans.md) - [Feature Groups](feature_flags/development.md#feature-groups) |