Skip to content

Commit 9509701

Browse files
RADAR-6702 | Add slack cloud data source onboarding doc (#1413)
Please go to the `Preview` tab and select the appropriate template: * [Consul](?expand=1&labels=Consul&title=Consul+Docs&template=consul_pull_request_template.md) * [HCP services](?expand=1&template=hcp_pull_request_template.md) * [Nomad](?expand=1&labels=Nomad&title=Nomad+Docs&template=nomad_pull_request_template.md) * [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)
2 parents b41882f + 25773e9 commit 9509701

File tree

5 files changed

+72
-0
lines changed

5 files changed

+72
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
page_title: Add a data source - Slack
3+
description: >-
4+
Add Slack as a data source for Vault Radar.
5+
---
6+
7+
# Onboard a Slack data source
8+
9+
@include 'private-beta-feature.mdx'
10+
11+
HCP Vault Radar allows you to connect to any workspace on [Slack
12+
](#onboard-slack) and scan for secrets in public channels.
13+
14+
## Prerequisites
15+
16+
- Permission in Slack to install third-party apps from the marketplace.
17+
18+
<Highlight title="Known limitations">
19+
20+
Vault Radar has a limit of 5000 channels per workspace. If you have more
21+
than 5000 channels, Vault Radar selects the 5000 channels with the
22+
most recent activity.
23+
24+
</Highlight>
25+
26+
## Add a Slack Data source
27+
28+
1. Click **Settings/Data Sources**.
29+
30+
1. Select **HCP Vault Radar Scan**.
31+
32+
1. Under **Team Collaboration**, click **Slack**.
33+
![Select Slack data source](/img/docs/vault-radar/slack-onboarding-flow.png)
34+
35+
1. Click **Connect to Slack** to **install the Slack app**. This initiates
36+
the OAuth flow with Slack.
37+
38+
1. Select the **Slack workspace** from the dropdown list and click **Allow**
39+
![Install Slack App onto a workspace](/img/docs/vault-radar/install-slack-app-to-workspace.png)
40+
41+
<Note title="Permission required to install Slack app">
42+
43+
If you do not have permission to install apps into the selected workspace,
44+
you will see a **Submit Request** button instead of the **Allow** button.
45+
46+
Coordinate with your Slack workspace administrator to approve the app
47+
installation.
48+
49+
</Note>
50+
51+
HCP Vault Radar displays the message **Authenticated to Slack**.
52+
53+
1. Click **Next**.
54+
55+
1. Select either **All active channels** or **Select channels to monitor**.
56+
57+
The onboarding workflow joins the Slack app to the selected channels. If you
58+
have a large number of channels, this process will take several minutes to
59+
complete.
60+
61+
1. Click **Finish** to start onboarding and scanning the selected channels.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<Note title="Private beta feature">
2+
3+
This feature is available as an _invitation only beta release_. Beta functionality is stable
4+
but possibly incomplete and subject to change. We strongly discourage using beta
5+
features in production.
6+
7+
</Note>

content/hcp-docs/data/docs-nav-data.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -702,6 +702,10 @@
702702
"path": "vault-radar/get-started/add-data-sources/jira/jira-data-center"
703703
}
704704
]
705+
},
706+
{
707+
"title": "Slack <sup>Beta</sup>",
708+
"path": "vault-radar/get-started/add-data-sources/slack/"
705709
}
706710
]
707711
},
270 KB
Loading
374 KB
Loading

0 commit comments

Comments
 (0)