Skip to content

Commit efebf03

Browse files
committed
Improved workshop setup
1 parent 3310163 commit efebf03

File tree

13 files changed

+117
-75
lines changed

13 files changed

+117
-75
lines changed

content/en/images/swipe.png

-211 KB
Binary file not shown.

content/en/workshop-setup.md

Lines changed: 0 additions & 75 deletions
This file was deleted.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: 1. Using SWiPE
3+
weight: 1
4+
hidden: false
5+
---
6+
7+
## Configure Your Org Using SWiPE
8+
9+
**SWiPE** is an online tool to help configure a workshop environment in Splunk Observability Cloud and is available [**here**](https://swipe.splunk.show).
10+
11+
{{% notice info %}}
12+
13+
Please note, **SWiPE does not** provision EC2 instances - these are provisioned using Splunk Show.
14+
15+
{{% /notice %}}
16+
17+
![SWiPE](../images/swipe.png)
18+
19+
**SWiPE** will configure the following:
20+
21+
- Create and invite users to the Org. Create a `.csv` file containing the e-mail addresses (one per line) **or** copy and paste e-mail addresses (one per line).
22+
- Create a team and add users to the team.
23+
- Create tokens for:
24+
- INGEST
25+
- API
26+
- RUM
27+
- HEC URL
28+
- HEC Token
29+
30+
You will need to make a copy of these to provision the EC2 instances in Splunk Show.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: 2. Using Splunk Show
3+
weight: 2
4+
---
5+
6+
## Provision the EC2 Instances Using Splunk Show
7+
8+
![Splunk Show](../images/splunk-show.png)
9+
10+
Please visit [**Splunk Show**](https://show.splunk.com/template/262/?type=workshop) to provision your EC2 environment(s). Select the desired **Content Type** as follows:
11+
12+
- _Default (for interactive workshop)_ - select this if your audience is technical and wants hands-on experience installing OpenTelemetry and deploying applications.
13+
- Select either Normal Workshop, Private Event or Public Event. Change **Estimated Participants** to the number of attendees you expect and set the same value in **O11y Shop Quantity**. This will provision the correct number of EC2 instances. It is recommended that you over-provision by 10% - 20% to allow for any last-minute attendees.
14+
- _Pre-configured Instances_ - select this if you need the OpenTelemetry Collector and the application pre-deployed for a less technical audience. Attendees will only require a browser to complete the workshop.
15+
- Select Normal Workshop only! Ensure that **Estimated Participants** is set to **1** and **O11y Shop Quantity** is set to **1** also as only a single instance is required by the workshop instructor.
16+
17+
{{% notice info %}}
18+
19+
- Ensure you set **Operating hours** to **Run always (24/7)** as this will prevent the instance from being suspended and obtaining a new IP address which breaks RUM and Synthetics.
20+
- Ensure you set a **DNS name** for the instance(s) as this makes it easier to find environments in Splunk Observability Cloud.
21+
22+
{{% /notice %}}
23+
24+
Select your Splunk Observability Cloud Realm and enter the INGEST, API, RUM tokens and the HEC URL and HEC Token that **SWiPE** generated for you.
25+
26+
For further guidance on using Splunk Show please see the [**Splunk Show User Guide**](http://go/show/user-guide).
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: 3. Workshop Clean-up
3+
weight: 3
4+
---
5+
6+
## Workshop Clean-up
7+
8+
Once you have completed your workshop session please remember to go back and clean up the environment using **SWiPE**. Also, ensure your EC2 instances are spun down to save costs.
9+
10+
**SWiPE** will complete the following:
11+
12+
- Delete all the users associated with the workshop
13+
- Delete the team
14+
- Delete the tokens (INGEST, API and RUM)
15+
- Delete user dashboards
16+
17+
![Delete Workshop](../images/delete-workshop.png)
18+
19+
**SWiPE** also provides some advanced features for deleting tokens and detectors etc., but this must be used with caution.
20+
21+
**Happy Workshopping!**
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: 4. Org Configuration
3+
weight: 4
4+
---
5+
6+
## Log Observer Connect
7+
8+
![Log Observer Connect](../images/log-observer-connect.png)
9+
10+
## Log Field Aliasing
11+
12+
![Log Field Aliasing](../images/log-field-aliasing.png)
13+
14+
## APM MetricSets
15+
16+
![APM MetricSets](../images/apm-metricsets.png)
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Workshop Setup
3+
linkTitle: Workshop Setup
4+
hidden: true
5+
---
6+
7+
## Available Workshop Orgs
8+
9+
The following Organizations are used for running Observability Workshops. They have all the features enabled to successfully run any of the available workshops.
10+
11+
- CoE Workshop EMEA [EU0]
12+
- Observability Workshop EMEA [EU0]
13+
- Observability Workshop AMER [US1]
14+
- APAC-O11y-Workshop [US1]
15+
16+
It is also possible to create workshop environments in any Trial Org. Please note, the following features are not available in Trial Orgs by default and must be enabled:
17+
18+
- Synthetic Monitoring
19+
20+
The following Orgs are blacklisted and cannot be used for running workshops:
21+
22+
- EU Splunk Show [EU0]
23+
- US Splunk Show [US1]
24+
- Show Playground [US1]
44.4 KB
Loading
164 KB
Loading
90.8 KB
Loading

0 commit comments

Comments
 (0)