Skip to content

Commit

Permalink
Improved workshop setup
Browse files Browse the repository at this point in the history
  • Loading branch information
rcastley committed Dec 6, 2023
1 parent efebf03 commit e6cc538
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 11 deletions.
11 changes: 6 additions & 5 deletions content/en/workshop-setup/1-swipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,22 @@ hidden: false

{{% notice info %}}

Please note, **SWiPE does not** provision EC2 instances - these are provisioned using Splunk Show.
**SWiPE does not** provision EC2 instances - these are provisioned using Splunk Show.

{{% /notice %}}

![SWiPE](../images/swipe.png)

**SWiPE** will configure the following:

- 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).
- 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).
- Create a team and add users to the team.
- Create tokens for:
- INGEST
- API
- RUM
- HEC URL
- HEC Token

You will need to make a copy of these to provision the EC2 instances in Splunk Show.
**SWiPE** will also provide a HEC Token and HEC URL for dedicated workshop Splunk Cloud environments. If you wish to use a different Splunk Cloud environment, you will need to provide a HEC Token and HEC URL for that environment in Splunk Show.

You will need to make a copy of the above to provision the workshop instances in Splunk Show.
4 changes: 3 additions & 1 deletion content/en/workshop-setup/2-splunk-show.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ weight: 2

![Splunk Show](../images/splunk-show.png)

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:
Please visit [**Splunk Show**](https://show.splunk.com/template/262/?type=workshop) to provision your workshop instance(s).

Select the desired **Content Type** as follows:

- _Default (for interactive workshop)_ - select this if your audience is technical and wants hands-on experience installing OpenTelemetry and deploying applications.
- 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.
Expand Down
4 changes: 2 additions & 2 deletions content/en/workshop-setup/3-clean-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 3

## Workshop Clean-up

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.
Once you have completed your workshop session please remember to go back and clean up the environment using **SWiPE**. Also, ensure your workshop instances are deleted to save costs.

**SWiPE** will complete the following:

Expand All @@ -16,6 +16,6 @@ Once you have completed your workshop session please remember to go back and cle

![Delete Workshop](../images/delete-workshop.png)

**SWiPE** also provides some advanced features for deleting tokens and detectors etc., but this must be used with caution.
**SWiPE** also provides some advanced features for deleting tokens and detectors etc., and these must be used with caution.

**Happy Workshopping!**
5 changes: 5 additions & 0 deletions content/en/workshop-setup/4-org-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,17 @@ weight: 4

## Log Observer Connect

The workshops require a Log Observer Connect configuration to be completed. This is required to be able to send logs from the workshop instances to Splunk Cloud/Enterprise.

![Log Observer Connect](../images/log-observer-connect.png)

## Log Field Aliasing

Log Field Aliasing configuration is required to ensure Related Content works correctly in the Splunk Observability Cloud UI. Configure as per the following:

![Log Field Aliasing](../images/log-field-aliasing.png)

## APM MetricSets

APM MetricSets need to be configured for the tags in the screenshot below.
![APM MetricSets](../images/apm-metricsets.png)
13 changes: 10 additions & 3 deletions content/en/workshop-setup/_index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
---
title: Workshop Setup
weight: 99
linkTitle: Workshop Setup
hidden: true
---

## Available Workshop Orgs
Welcome to the Observability Workshop Setup Guide. This guide will walk you through the steps required to set up your workshop environments.

The following Organizations are used for running Observability Workshops. They have all the features enabled to successfully run any of the available workshops.
## Existing Workshop Orgs

The following Organizations can be used for running Observability Workshops. They have all the features enabled to successfully run any of the available workshops:

- CoE Workshop EMEA [EU0]
- Observability Workshop EMEA [EU0]
- Observability Workshop AMER [US1]
- APAC-O11y-Workshop [US1]

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:
## Trial Orgs

It is also possible to create workshop environments in any trial Org. A default trial provides 25 hosts, 25 APM hosts and 25 x 10k RUM sessions per month. Please note, the following features are not available in Trial Orgs by default and must be enabled:

- Synthetic Monitoring

Also, a Splunk Cloud/Enterprise environment is required to be able to send logs. In Splunk Cloud/Enterprise make sure an index exists called **splunk4rookies-workshop**. A Log Observer Connect configuration will also need to be completed.

The following Orgs are blacklisted and cannot be used for running workshops:

- EU Splunk Show [EU0]
Expand Down

0 comments on commit e6cc538

Please sign in to comment.