From 0af83e30e5ee92f3609075d3a882cbe65507b47d Mon Sep 17 00:00:00 2001 From: Robert Castley Date: Fri, 20 Oct 2023 17:00:48 +0100 Subject: [PATCH] Deployed 3172f7a with MkDocs version: 1.5.3 --- .DS_Store | Bin 0 -> 6148 bytes search/search_index.json | 1 - sitemap.xml.gz | Bin 127 -> 127 bytes 3 files changed, 1 deletion(-) create mode 100644 .DS_Store delete mode 100644 search/search_index.json diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..76715f1791151d769fdf9c247dfd2d612375d927 GIT binary patch literal 6148 zcmeHK%}T>S5Z-O8O({YS3Oz1(E!ZDhDqcdYFJMFuDzzb1gE3p0)E-J9XMG``#OHBl zcLP>)@FZeqVDrt+&+g6#*&oIjcjrNyF`F@FK||!I6bPCNT_qEY$kiAv)?rIhw)^l62f2tA=j5-9LR+$=W&pzTu(c!npGRwjpee}A2db3 zH&`{r@~G2lioVbC#{ zX#@`l*QtOym76C9*XdvvCeAUKY1HYAtC?XOGjslU;c9lU3l+||qmjPE05P!6Kv{Qf zJpWJOmnnSYucuIt7$64z83VjB^oA}JWzN=b<>6T?pxr`4!MF?+5YX2y0novHq@kSJ cFHna#$6%%rM?t$v2c(ODB7{D~z%MZH0nn&Pm;e9( literal 0 HcmV?d00001 diff --git a/search/search_index.json b/search/search_index.json deleted file mode 100644 index fce1201..0000000 --- a/search/search_index.json +++ /dev/null @@ -1 +0,0 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":"

Welcome to the Splunk Data Drivers F1 Telemetry Simulator!

"},{"location":"event_guide/","title":"Overview","text":"

This site will guide you on:

  • Familiarize you on how to setup the local Data Drivers racing simulators to expose data
  • Get data into Splunk for the simulators
  • Access the demo environments

Please reach out Slack on #datadrivers-inh if you have any emergencies arise. Please email datadrivers@splunk.com for any feedback or feature requests.

"},{"location":"event_guide/lan/","title":"For LOCAL-LAN Game Play as Host (Work in progress)","text":"
  1. Go to Multiplayer tab on main menu bar (using paddle shifter or F6 key)
  2. Select \"LAN GAME\" box (using dpad on steering wheel or arrow keys on keyboard)
  3. Select \"Host LAN Game\"
  4. Go to Settings, Press Enter
  5. Select \"Lobby Options\"
    1. Car Category: F1 2021
  6. Press Escape to return to the LAN Settings menu
  7. Go to \"TRACK SELECT\"
  8. With the BAHRAIN Track highlighted arrow over to CANADA track (6 right arrow clicks)
  9. Press Escape to return to the LAN Settings menu
  10. Select over to Rules and Flags Chiclet and press Enter
    1. Rules and Flags: Off
    2. Parc Ferm\u00e9 Rules: Off
    3. Formation Lap: Off
  11. Press Escape to return to the LAN Settings menu
  12. Select the Simulation Settings button
    1. Surface Type: Realistic
    2. Recovery Mode: Auto Reset to Track
    3. Car Damage: Off
    4. Low Fuel Mode: Easy
    5. Race Starts: Assisted
    6. Collisions: On
    7. Ghosting: On
    8. Unsafe Pit Release: On
  13. Press ESC to return to the LAN Settings menu
  14. Select Weekend Structure
    1. Practice Format: Off
    2. Qualifying Format: Off
    3. Session Length: Short
    4. Starting Grid: Random
  15. Press ESC to return to the LAN Settings menu
  16. Select the Assists Restrictions Menu
    1. Steering assist: Off
    2. Braking Assist: medium
    3. Anti-Lock Brakes: Off
    4. Traction Control: Full
    5. Dynamic Racing Line: Full
    6. Gearbox: Automatic
    7. Pit Assist: On
    8. Pit Release Assist: On
    9. ERS Assist: On
    10. DRS Assist: On
  17. Press ESC to return to the LAN Settings menu
  18. Select the Assists Menu
    1. Steering assist: Off
    2. Braking assist: Medium
    3. Traction Control : Full
    4. Dynamic Racing Line: Full
    5. Dynamic Racing Line Type: 3D
    6. Gearbox: Automatic
    7. Pit Assist: On
    8. Pit Release Assist: On
    9. ERS Assist: On
    10. DRS Assist: On
  19. Press ESC to return to the LAN Settings Menu
  20. Select the Weather and Time of Day Menu
    1. Quick Weather: Light Cloud (Dry)
    2. Session Start Time: Midday
  21. Press ESC to return to the LAN Settings Menu
  22. Press ESC to return to the Lobby
  23. Press F6 or paddle shift right to Select Team and Driver
    1. Select your Driver. Prioritize McLaren first, then other teams
  24. Press F5 or paddle shift left to go back to lobby and wait for other sim_rigs to join
  25. When everyone is ready to race, press \"X\" on the steering wheel to \"Ready Up\". The Race will advance when there is a majority of racers who have pressed \"Ready Up\".
"},{"location":"event_guide/lan/#for-local-lan-game-play-as-sim_rig_2-4-work-in-progress","title":"For LOCAL-LAN Game Play as Sim_Rig_2-4 (Work in progress)","text":"
  1. Go to Multiplayer tab on main menu bar (using paddle shifter or F6 key)
  2. Select \"LAN GAME\" box (using dpad on steering wheel or arrow keys on keyboard)
  3. Select \"Find game on subnet\"
  4. After the search completes, select the game that appears.
  5. Press F6 or paddle shift right to Select Team and Driver
    1. Select your Driver. Prioritize McLaren first, then other teams
  6. Press F5 or paddle shift left to go back to lobby and wait for other sim_rigs to join
  7. When everyone is ready to race, press \"X\" on the steering wheel to \"Ready Up\". The Race will advance when there is a majority of racers who have pressed \"Ready Up\".
"},{"location":"event_guide/solo/","title":"Game Configuration (Solo Play)","text":"
  1. Go to Solo tab on main menu bar (using paddle shifter or F6 key)
  2. Select \"GRAND PRIX\" box (using dpad on steering wheel or arrow keys on keyboard)
  3. Select \"Start new Grand Prix\"
  4. Accept the \"Are you sure you want to proceed?\" prompt
  5. Select the F1 2023 car option
  6. With the BAHRAIN Track highlighted arrow over to CANADA track (6 right arrow clicks)
  7. Press Enter to advance to car selection screen
  8. Select the McLaren car
  9. Select your favorite McLaren driver. (Lando obviously (poor Oscar) ), and press enter
  10. You are now at the Grand Prix Settings Screen
  11. Highlight the assists option and press Enter
    1. Steering assist: Off
    2. Braking assist: Medium
    3. Traction Control : Full
    4. Dynamic Racing Line: Full
    5. Dynamic Racing Line Type: 3D
    6. Gearbox: Automatic
    7. Pit Assist: On
    8. Pit Release Assist: On
    9. ERS Assist: On
    10. DRS Assist: On
  12. Press ESC to return to the Grand Prix Settings Screen
  13. Select over to Rules and Flags Chiclet and press Enter
    1. Rules and Flags: Off
    2. Parc Ferm\u00e9 Rules: Off
  14. Select Weekend Structure
    1. Practice Format: Off
    2. Qualifying Format: Off
    3. Session Length: Short
  15. Press ESC to return to the Grand Prix Settings screen
  16. Select the Simulation Settings button
    1. Recovery Mode: Auto Reset to Track
    2. Car Damage: Off
    3. Low Fuel Mode: Easy
    4. Race Starts: Assisted
    5. Collisions: On
  17. Press ESC to return to the Grand Prix Settings screen
  18. Select the Weather and Time of Day screen
    1. Quick Weather: Light Cloud (Dry)
    2. Session Start Time: Midday
  19. Press ESC to return to the Grand Prix Settings screen
  20. You are now ready to race, Select START EVENT
  21. You will have a lot of preroll. Press enter to skip through all of this. You should now be at the cockpit view of the car on the track. The car is stopped with people infront of it.
  22. Press enter to start the race.
  23. At the end of the race, advance to the post race leaderboard. You should see the word \"Advance\" at the top of the menu stack and \"Restart Session\" at the bottom.
  24. Arrow down to Restart Session. Press enter and confirm your restart on the prompt.
    1. If you end up accidentally advancing, you will need to reconfigure the settings in this guide between every race.
  25. You should now be at the cockpit view from end of step 21.
  26. You are now ready for the next participant.
"},{"location":"f1_2023/","title":"Pre-requisites","text":""},{"location":"f1_2023/#recommended-environments","title":"Recommended environment(s)","text":"
  • Apple MacBook (Apple Silicon M1/M2)
  • AWS/EC2 (Ubuntu 22.04 or above)
    • t2.large (2 vCPU, 8GB RAM)
    • External IP address
    • Inbound access on ports 8501/tcp and 20777-20784/udp
"},{"location":"f1_2023/#install-docker","title":"Install Docker","text":"

Docker is required to run the F1 2023 UDP listener and UI. The UDP listener will take the UDP stream from F1 2023 and transform the stream into metric payload for Splunk Observability Cloud and Splunk Enterprise/Cloud. The UI is used to configure where to send the metrics, start/stop the UDP listener(s) and change the name of the current driver.

The following instructions will install Docker on your laptop or EC2 instance:

Mac OSUbuntu

Download Docker Desktop for Mac with Apple Silicon

sudo apt remove docker docker-engine docker.io containerd runc\nsudo apt update\nsudo apt install ca-certificates curl gnupg -y\nsudo install -m 0755 -d /etc/apt/keyrings\ncurl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg\nsudo chmod a+r /etc/apt/keyrings/docker.gpg\necho \\\n\"deb [arch=\"$(dpkg --print-architecture)\" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \\\n\"$(. /etc/os-release && echo \"$VERSION_CODENAME\")\" stable\" | \\\nsudo tee /etc/apt/sources.list.d/docker.list > /dev/null\nsudo apt update\nsudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y\nsudo usermod -aG docker $USER\n
"},{"location":"f1_2023/configuration/","title":"Configuration","text":""},{"location":"f1_2023/configuration/#number-of-rigs","title":"Number of Rigs","text":"

Usually this will be 1, but in some cases at large events multiple rigs will be used. In this case you can specify the number of rigs here.

"},{"location":"f1_2023/configuration/#observability-cloud","title":"Observability Cloud","text":""},{"location":"f1_2023/configuration/#realm","title":"Realm","text":"

Realm name for the Observability Cloud realm you want to send data to e.g. us1, eu0 etc.

"},{"location":"f1_2023/configuration/#access-token","title":"Access Token","text":"

Observability Cloud access token (must have ingest capability). This can be done by following the instructions here.

"},{"location":"f1_2023/configuration/#splunk-cloudenterprise","title":"Splunk Cloud/Enterprise","text":""},{"location":"f1_2023/configuration/#hec-url","title":"HEC URL","text":"

HEC URL for Splunk Cloud/Enterprise e.g. https://simulator.prod.splunkcloud.com:8088.

"},{"location":"f1_2023/configuration/#hec-token","title":"HEC Token","text":"

HEC Token for Splunk Cloud/Enterprise.

"},{"location":"f1_2023/configuration/#enable-sending-metrics","title":"Enable sending metrics","text":"

You are able to send the metrics to both Observability Cloud and Splunk Cloud/Enterprise. To enable either or both just tick the relevant boxes.

  • Tick Enable Observability Cloud to enable sending data to O11y Cloud.
  • Tick Enable Splunk Cloud to enable sending data to Splunk Cloud.

Finally click Save Configuration

"},{"location":"f1_2023/dashboards/","title":"Dashboards","text":""},{"location":"f1_2023/dashboards/#splunk-observability-cloud","title":"Splunk Observability Cloud","text":"

You can import the following dashboard into your Observability Cloud Organization. You will need an existing dashboard group to import the dashboard into. If you don't have one, you can create one by following the instructions here.

Download the JSON file here.

"},{"location":"f1_2023/dashboards/#splunk-enterprisecloud","title":"Splunk Enterprise/Cloud","text":""},{"location":"f1_2023/game/","title":"F1 2023 Telemetry Configuration","text":"

In the F1 2023 you will need to configure the telemetry settings to send data to the F1 2023 container.

On the main screen select Game Options, then click on Settings and then Telemetry Settings.

Here you will need to set the following:

  • UDP Telemetry: On
  • UDP Broadcast Mode: Off
  • UDP IP Address: IP address of the laptop/EC2 instance running the container
  • UDP Port: 20777
  • UDP Send Rate: 10Hz
  • UDP Format: 2023

If you are running multiple simulators, you will need to repeat the above for each remebering to change the UDP Port for each simulator.

"},{"location":"f1_2023/setup/","title":"Running the F1 2023 container","text":""},{"location":"f1_2023/setup/#mac-os","title":"Mac OS","text":"

The following Docker command will run the F1 2023 container on Mac OS:

docker run --name f1_2023 -d -p 8501:8501/tcp -p 20777:20777/udp ghcr.io/splunk/f1_2023:latest\n

The above will run the F1 2023 container in the background and expose port 8501 for the UI and port 20777 for the UDP listener.

Note

If you are using more than one simulator you can expose up to 8 UDP ports, for example, if you have 4 simulators running you would start the container by running:

docker run --name f1_2023 -d -p 8501:8501/tcp -p 20777:20777/udp -p 20778:20778/udp -p 20779:20779/udp -p 20780:20780/udp ghcr.io/splunk/f1_2023:latest\n
"},{"location":"f1_2023/setup/#ubuntu","title":"Ubuntu","text":"

The following Docker command will run the F1 2023 container on Ubuntu:

docker run --name f1_2023 -d -p 8501:8501/tcp -p 20777:20777/udp ghcr.io/splunk/f1_2023-amd64:latest\n

The same instructions to expose additional UDP ports apply to Ubuntu as well as was described in the Mac OS section.

"},{"location":"f1_2023/setup/#validation","title":"Validation","text":"

To validate the container is running correctly you can run the following command:

CommandOutput
docker port f1_2023\n
8501/tcp -> 0.0.0.0:8501\n20777/udp -> 0.0.0.0:20777\n
"},{"location":"f1_2023/ui/","title":"F1 2023 Web Interface","text":"

To access the UI open a browser and navigate to http://<ip_address>:8501 where <ip_address> is the IP address of the laptop/EC2 instance running the container.

Here you can configure where the game data is going to be sent.

"}]} \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index e0618b94a5067c15345eb718d169de10063f8faa..2b4c07139d5fedd86846dbce40e1884885259137 100644 GIT binary patch delta 12 Tcmb=gXOr*d;4oM+k*yK{7eE7} delta 12 Tcmb=gXOr*d;CQicB3mT@8q5S(