diff --git a/.github/actions/setup/action.yml b/.github/actions/setup/action.yml index e6995d5e3b..e78a56a2cf 100644 --- a/.github/actions/setup/action.yml +++ b/.github/actions/setup/action.yml @@ -7,7 +7,7 @@ runs: - name: Setup Hugo uses: peaceiris/actions-hugo@v2 with: - hugo-version: '0.92.2' + hugo-version: '0.110.0' extended: true - name: Setup yq @@ -51,7 +51,7 @@ runs: shell: bash run: npm ci --cache .npm --prefer-offline - - name: Get Submodules - shell: bash - run: cd themes/docsy && git submodule update -f --init --jobs=6 && cd ../.. +# - name: Get Submodules +# shell: bash +# run: cd themes/docsy && git submodule update -f --init --jobs=6 && cd ../.. diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index b76244d3b5..0000000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "themes/docsy"] - path = themes/docsy - url = https://github.com/google/docsy.git diff --git a/config.yaml b/config.yaml index 126e9ec5f7..9314bbeff8 100644 --- a/config.yaml +++ b/config.yaml @@ -6,7 +6,8 @@ defaultContentLanguageInSubdir: false enableMissingTranslationPlaceholders: true enableRobotsTXT: true theme: - - docsy + - github.com/google/docsy + - github.com/google/docsy/dependencies enableGitInfo: true taxonomies: tag: tags diff --git a/content/en/apm/docs/online-boutique/deploy.md b/content/en/apm/docs/online-boutique/deploy.md index c74e155a8b..6e30305829 100644 --- a/content/en/apm/docs/online-boutique/deploy.md +++ b/content/en/apm/docs/online-boutique/deploy.md @@ -21,12 +21,12 @@ otherwise if you have received a fresh instance, please run the first two (2) se To deploy the Online Boutique application into K3s, run the apm-config script, then apply the deployment: {{< tabpane >}} -{{< tab header="Deploy Online Boutique" lang="bash" >}} +{{< tab header="Deploy Online Boutique" lang="sh" >}} cd ~/workshop/apm ./apm-config.sh kubectl apply -f deployment.yaml {{< /tab >}} -{{< tab header="Deployment Output" lang= "bash" >}} +{{< tab header="Deployment Output" lang= "text" >}} APM Only Deployment deployment.apps/recommendationservice created service/recommendationservice created @@ -65,10 +65,10 @@ Then export the variable as described in the guide/message, followed by rerunnin To ensure the Online Boutique application is running: {{< tabpane >}} -{{< tab header="Get Pods" lang="bash" >}} +{{< tab header="Get Pods" lang="sh" >}} kubectl get pods {{< /tab >}} -{{< tab header="Get Pods Output" lang= "bash" >}} +{{< tab header="Get Pods Output" lang= "text" >}} NAME READY STATUS RESTARTS AGE splunk-otel-collector-k8s-cluster-receiver-849cf595bf-l7mnq 1/1 Running 0 31m splunk-otel-collector-agent-pxrgp 2/2 Running 0 31m diff --git a/content/en/apm/docs/online-boutique/locust.md b/content/en/apm/docs/online-boutique/locust.md index f2c467173d..48b8ed6bc8 100644 --- a/content/en/apm/docs/online-boutique/locust.md +++ b/content/en/apm/docs/online-boutique/locust.md @@ -26,12 +26,12 @@ For this we need to know the name of your application environment. In this works To find the hostname, on the AWS/EC2 instance run the following command: {{< tabpane >}} - {{< tab header="Echo Hostname" lang="bash" >}} - echo $(hostname)-apm-env - {{< /tab >}} - {{< tab header="Output Example" lang= "bash" >}} - bdzx-apm-env - {{< /tab >}} +{{< tab header="Echo Hostname" lang="sh" >}} +echo $(hostname)-apm-env +{{< /tab >}} +{{< tab header="Output Example" lang= "text" >}} +bdzx-apm-env +{{< /tab >}} {{< /tabpane >}} Select your environment you found in the previous step then select the `frontend` service and set time to Past 15 minutes. @@ -84,7 +84,7 @@ To debug the traces being sent you can use the zpages extension. [zpages][zpages Alternatively, from your shell prompt you can run a text based browser: {{< tabpane >}} - {{< tab header="Lynx Command" lang="text" >}} - lynx http://localhost:55679/debug/tracez - {{< /tab >}} +{{< tab header="Lynx Command" lang="text" >}} +lynx http://localhost:55679/debug/tracez +{{< /tab >}} {{< /tabpane >}} diff --git a/content/en/imt/docs/gdi/k3s.md b/content/en/imt/docs/gdi/k3s.md index 87fe84fe85..4448b61c47 100644 --- a/content/en/imt/docs/gdi/k3s.md +++ b/content/en/imt/docs/gdi/k3s.md @@ -30,20 +30,21 @@ You will also need to obtain the name of the Realm[^2] for your Splunk account. Create the `ACCESS_TOKEN` and `REALM` environment variables to use in the proceeding Helm install command. For instance, if your realm is `us1`, you would type `export REALM=us1` and for `eu0` type `export REALM=eu0`. {{< tabpane >}} -{{< tab header="Export ACCESS TOKEN" lang="bash" >}} +{{< tab header="Export ACCESS TOKEN" lang="sh" >}} export ACCESS_TOKEN="" {{< /tab >}} {{< /tabpane >}} {{< tabpane >}} -{{< tab header="Export REALM" lang="bash" >}} +{{< tab header="Export REALM" lang="sh" >}} export REALM="" {{< /tab >}} {{< /tabpane >}} Install the OpenTelemetry Collector using the Splunk Helm chart. First, add the Splunk Helm chart repository to Helm and update. + {{< tabpane >}} -{{< tab header="Helm Repo Add" lang="bash" >}} +{{< tab header="Helm Repo Add" lang="sh" >}} helm repo add splunk-otel-collector-chart https://signalfx.github.io/splunk-otel-collector-chart && helm repo update {{< /tab >}} {{< tab header="Helm Repo Add Output" lang="text" >}} @@ -61,7 +62,7 @@ Update Complete. ⎈Happy Helming!⎈ Install the OpenTelemetry Collector Helm chart with the following commands, do **NOT** edit this: {{< tabpane >}} -{{< tab header="Helm Install" lang="text" >}} +{{< tab header="Helm Install" lang="sh" >}} helm install splunk-otel-collector \ --set="splunkObservability.realm=$REALM" \ --set="splunkObservability.accessToken=$ACCESS_TOKEN" \ @@ -73,9 +74,6 @@ helm install splunk-otel-collector \ splunk-otel-collector-chart/splunk-otel-collector \ -f ~/workshop/k3s/otel-collector.yaml {{< /tab >}} -{{< tab header="Helm Install Single Line" lang="text" >}} -helm install splunk-otel-collector --set="splunkObservability.realm=$REALM" --set="splunkObservability.accessToken=$ACCESS_TOKEN" --set="clusterName=$(hostname)-k3s-cluster" --set="splunkObservability.logsEnabled=true" --set="splunkObservability.profilingEnabled=true" --set="environment=$(hostname)-apm-env" splunk-otel-collector-chart/splunk-otel-collector -f ~/workshop/k3s/otel-collector.yaml -{{< /tab >}} {{< tab header="Helm Install Output" lang="text" >}} Using ACCESS_TOKEN={REDACTED} Using REALM=eu0 @@ -86,7 +84,7 @@ STATUS: deployed REVISION: 1 TEST SUITE: None {{< /tab >}} -{{< tab header="Install Network Explorer" lang="text" >}} +{{< tab header="Install Network Explorer" lang="zsh" >}} helm install splunk-otel-collector \ --set="splunkObservability.realm=$REALM" \ --set="splunkObservability.accessToken=$ACCESS_TOKEN" \ @@ -111,7 +109,7 @@ You can monitor the progress of the deployment by running `kubectl get pods` whi Ensure the status is reported as Running before continuing. {{< tabpane >}} -{{< tab header="Kubectl Get Pods" lang="text" >}} +{{< tab header="Kubectl Get Pods" lang="sh" >}} kubectl get pods {{< /tab >}} {{< tab header="Kubectl Get Pods Output" lang="text" >}} @@ -126,7 +124,7 @@ Ensure there are no errors by tailing the logs from the OpenTelemetry Collector Use the label set by the `helm` install to tail logs (You will need to press `ctrl+c` to exit). Or use the installed `k9s` terminal UI for bonus points! {{< tabpane >}} -{{< tab header="Kubectl Logs" lang="text" >}} +{{< tab header="Kubectl Logs" lang="sh" >}} kubectl logs -l app=splunk-otel-collector -f --container otel-collector {{< /tab >}} {{< tab header="Kubectl Logs Output" lang="text" >}} @@ -146,7 +144,7 @@ kubectl logs -l app=splunk-otel-collector -f --container otel-collector {{% alert title="Deleting a failed installation" color="danger" %}} If you make an error installing the OpenTelemetry Collector you can start over by deleting the installation using: -``` text +``` sh helm delete splunk-otel-collector ``` @@ -165,7 +163,7 @@ Under **Containers** click on **Kubernetes** to open the Kubernetes Navigator Cl Validate that your cluster is discovered and reporting by finding your cluster (in the workshop you will see many other clusters). To find your cluster name run the following command and copy the output to your clipboard: {{< tabpane >}} -{{< tab header="Echo Cluster Name" lang="bash" >}} +{{< tab header="Echo Cluster Name" lang="sh" >}} echo $(hostname)-k3s-cluster {{< /tab >}} {{< /tabpane >}} diff --git a/content/en/oncall/docs/getting_started/routing.md b/content/en/oncall/docs/getting_started/routing.md index 5de0a0a6fb..169fa75238 100644 --- a/content/en/oncall/docs/getting_started/routing.md +++ b/content/en/oncall/docs/getting_started/routing.md @@ -23,10 +23,10 @@ Your welcome e-mail informed you of the details of your EC2 Instance that has be The e-mail also contained the Hostname of the Instance, but you can also obtain it from the Instance directly. To get your Hostname from within the shell session connected to your Instance run the following command: {{< tabpane >}} -{{< tab header="Export Hostname" lang="bash" >}} +{{< tab header="Export Hostname" lang="sh" >}} echo ${HOSTNAME} {{< /tab >}} -{{< tab header="Example Output" lang="bash" >}} +{{< tab header="Example Output" lang="text" >}} zevn {{< /tab >}} {{< /tabpane >}} diff --git a/content/en/rum/docs/setup.md b/content/en/rum/docs/setup.md index 0d31f26498..c99b63768a 100644 --- a/content/en/rum/docs/setup.md +++ b/content/en/rum/docs/setup.md @@ -30,7 +30,7 @@ We have created a RUM Token specifically for this workshop with the appropriate Create the `RUM_TOKEN` environment variable to use in the proceeding shell script to personalize your deployment. {{< tabpane >}} -{{< tab header="Export Variables" lang="bash" >}} +{{< tab header="Export Variables" lang="sh" >}} export RUM_TOKEN= {{< /tab >}} {{< /tabpane >}} @@ -40,12 +40,12 @@ export RUM_TOKEN= To deploy the Online Boutique application into K3s, run the apm config script, then apply the deployment: {{< tabpane >}} -{{< tab header="Deploy Online Boutique" lang="bash" >}} +{{< tab header="Deploy Online Boutique" lang="sh" >}} cd ~/workshop/apm ./apm-config.sh -r kubectl apply -f deployment.yaml {{< /tab >}} -{{< tab header="Deployment Output" lang= "bash" >}} +{{< tab header="Deployment Output" lang= "text" >}} deployment.apps/checkoutservice created service/checkoutservice created deployment.apps/redis-cart created diff --git a/content/en/rum/showcase.md b/content/en/rum/showcase.md index 2adfd14300..949b383fa1 100644 --- a/content/en/rum/showcase.md +++ b/content/en/rum/showcase.md @@ -5,6 +5,7 @@ menu: docs: weight: 3 --- + * Find the Web address of your workshop hosts Online Boutique * Generate traffic by shopping for bargains on your workshop hosted Online Boutique web shop. @@ -32,7 +33,7 @@ We have created a RUM Token specifically for this workshop with the appropriate Create the `RUM_TOKEN` environment variable to use in the proceeding shell script to personalize your deployment. {{< tabpane >}} -{{< tab header="Export Variables" lang="bash" >}} +{{< tab header="Export Variables" lang="sh" >}} export RUM_TOKEN= {{< /tab >}} {{< /tabpane >}} @@ -42,13 +43,13 @@ export RUM_TOKEN= To deploy the Online Boutique application into your EC2 instance kubernetes (K3s) installation delete the original deployment, then run the apm config script for RUM, then apply the RUM deployment: {{< tabpane >}} -{{< tab header="Deploy Online Boutique with RUM" lang="bash" >}} +{{< tab header="Deploy Online Boutique with RUM" lang="sh" >}} cd ~/workshop/apm kubectl delete -f deployment.yaml ./apm-config.sh -r kubectl apply -f deployment.yaml {{< /tab >}} -{{< tab header="Partial Deployment Output" lang= "bash" >}} +{{< tab header="Partial Deployment Output" lang= "text" >}} ...... Adding RUM_TOKEN to deployment deployment.apps/recommendationservice created diff --git a/content/ja/apm/docs/online-boutique/deploy.md b/content/ja/apm/docs/online-boutique/deploy.md index 03069cc67f..5836a1bb7d 100644 --- a/content/ja/apm/docs/online-boutique/deploy.md +++ b/content/ja/apm/docs/online-boutique/deploy.md @@ -22,12 +22,12 @@ isCJKLanguage: true Online BoutiqueアプリケーションをK3sにデプロイするには、以下のデプロイメントを適用します。 {{< tabpane >}} -{{< tab header="Deploy Online Boutique" lang="bash" >}} +{{< tab header="Deploy Online Boutique" lang="sh" >}} cd ~/workshop/apm ./apm-config.sh kubectl apply -f deployment.yaml {{< /tab >}} -{{< tab header="Deployment Output" lang= "bash" >}} +{{< tab header="Deployment Output" lang= "text" >}} APM Only Deployment deployment.apps/recommendationservice created service/recommendationservice created @@ -66,10 +66,10 @@ deployment.apps/rum-loadgen-deployment created Online Boutique アプリケーションが起動していることを確認するには: {{< tabpane >}} -{{< tab header="Get Pods" lang="bash" >}} +{{< tab header="Get Pods" lang="sh" >}} kubectl get pods {{< /tab >}} -{{< tab header="Get Pods Output" lang= "bash" >}} +{{< tab header="Get Pods Output" lang= "text" >}} NAME READY STATUS RESTARTS AGE splunk-otel-collector-k8s-cluster-receiver-56585564cc-xclzj 1/1 Running 0 84s splunk-otel-collector-agent-hkshj 1/1 Running 0 84s diff --git a/content/ja/apm/docs/online-boutique/locust.md b/content/ja/apm/docs/online-boutique/locust.md index 8fbaf4259f..a15d0fc66d 100644 --- a/content/ja/apm/docs/online-boutique/locust.md +++ b/content/ja/apm/docs/online-boutique/locust.md @@ -27,12 +27,12 @@ Locust は、EC2インスタンスのIPアドレスの82番ポートで利用で ホスト名を調べるには、AWS/EC2インスタンス上で以下のコマンドを実行します: {{< tabpane >}} - {{< tab header="Echo Hostname" lang="bash" >}} - echo $(hostname)-apm-env - {{< /tab >}} - {{< tab header="Output Example" lang= "bash" >}} - bdzx-apm-env - {{< /tab >}} +{{< tab header="Echo Hostname" lang="sh" >}} +echo $(hostname)-apm-env +{{< /tab >}} +{{< tab header="Output Example" lang= "text" >}} +bdzx-apm-env +{{< /tab >}} {{< /tabpane >}} 前のステップで見つけた Environment を選択し、「frontend」サービスを選択し、時間を「Past 15 minutes」に設定します。 @@ -85,7 +85,7 @@ Open Telemetery Collector がデプロイされると、プラットフォーム また、シェルプロンプトから、テキストベースのブラウザを実行することもできます。 {{< tabpane >}} - {{< tab header="Lynx Command" lang="text" >}} - lynx http://localhost:55679/debug/tracez - {{< /tab >}} +{{< tab header="Lynx Command" lang="text" >}} +lynx http://localhost:55679/debug/tracez +{{< /tab >}} {{< /tabpane >}} diff --git a/content/ja/imt/docs/gdi/k3s.md b/content/ja/imt/docs/gdi/k3s.md index f8106130bc..1970c1b47b 100644 --- a/content/ja/imt/docs/gdi/k3s.md +++ b/content/ja/imt/docs/gdi/k3s.md @@ -32,22 +32,21 @@ Kubernetes が起動したら、Splunk の UI から Access Token[^1] を取得 環境変数 `ACCESS_TOKEN` と `REALM` を作成して、進行中の Helm のインストールコマンドで使用します。例えば、Realm が `us1` の場合は、`export REALM=us1` と入力し、`eu0` の場合は、`export REALM=eu0` と入力します。 {{< tabpane >}} -{{< tab header="Export Variables" lang="bash" >}} -export ACCESS_TOKEN= -export REALM= +{{< tab header="Export ACCESS TOKEN" lang="sh" >}} +export ACCESS_TOKEN="" {{< /tab >}} -{{< tab header="Export Access Token" lang="bash" >}} -export ACCESS_TOKEN= -{{< /tab >}} -{{< tab header="Export Realm" lang="bash" >}} -export REALM= +{{< /tabpane >}} + +{{< tabpane >}} +{{< tab header="Export REALM" lang="sh" >}} +export REALM="" {{< /tab >}} {{< /tabpane >}} Splunk Helm チャートを使って OpenTelemetry Collector をインストールします。まず、Splunk Helm chart のリポジトリを Helm に追加してアップデートします。 {{< tabpane >}} -{{< tab header="Helm Repo Add" lang="bash" >}} +{{< tab header="Helm Repo Add" lang="sh" >}} helm repo add splunk-otel-collector-chart https://signalfx.github.io/splunk-otel-collector-chart && helm repo update {{< /tab >}} {{< tab header="Helm Repo Add Output" lang="text" >}} @@ -65,7 +64,7 @@ Update Complete. ⎈Happy Helming!⎈ 以下のコマンドでOpenTelemetry Collector Helmチャートをインストールします。これは **変更しないでください**。 {{< tabpane >}} -{{< tab header="Helm Install" lang="bash" >}} +{{< tab header="Helm Install" lang="sh" >}} helm install splunk-otel-collector \ --set="splunkObservability.realm=$REALM" \ --set="splunkObservability.accessToken=$ACCESS_TOKEN" \ @@ -76,9 +75,6 @@ helm install splunk-otel-collector \ splunk-otel-collector-chart/splunk-otel-collector \ -f ~/workshop/k3s/otel-collector.yaml {{< /tab >}} -{{< tab header="Helm Install Single Line" lang="bash" >}} -helm install splunk-otel-collector --set="splunkObservability.realm=$REALM" --set="splunkObservability.accessToken=$ACCESS_TOKEN" --set="clusterName=$(hostname)-k3s-cluster" --set="splunkObservability.logsEnabled=true" --set="splunkObservability.profilingEnabled=true" --set="environment=$(hostname)-apm-env" splunk-otel-collector-chart/splunk-otel-collector -f ~/workshop/k3s/otel-collector.yaml -{{< /tab >}} {{< tab header="Helm Install Output" lang="text" >}} Using ACCESS_TOKEN={REDACTED} Using REALM=eu0 diff --git a/content/ja/rum/docs/setup.md b/content/ja/rum/docs/setup.md index 71fd77721d..d33988d4b7 100644 --- a/content/ja/rum/docs/setup.md +++ b/content/ja/rum/docs/setup.md @@ -32,7 +32,7 @@ Online BoutiqueがインストールされたEC2インスタンスにアクセ EC2にSSHアクセスしているシェルスクリプトで環境変数 `RUM_TOKEN` を作成し、デプロイメントをパーソナライズします。 {{< tabpane >}} -{{< tab header="Export Variables" lang="bash" >}} +{{< tab header="Export Variables" lang="sh" >}} export RUM_TOKEN= {{< /tab >}} {{< /tabpane >}} @@ -42,12 +42,12 @@ export RUM_TOKEN= Online BoutiqueアプリケーションをK3sにデプロイするには、apm configスクリプトを実行し、デプロイを適用してください。 {{< tabpane >}} -{{< tab header="Deploy Online Boutique" lang="bash" >}} +{{< tab header="Deploy Online Boutique" lang="sh" >}} cd ~/workshop/apm ./apm-config.sh -r kubectl apply -f deployment.yaml {{< /tab >}} -{{< tab header="Deployment Output" lang= "bash" >}} +{{< tab header="Deployment Output" lang= "text" >}} deployment.apps/checkoutservice created service/checkoutservice created deployment.apps/redis-cart created diff --git a/content/ja/rum/showcase.md b/content/ja/rum/showcase.md index 24b1f5e15c..003b811789 100644 --- a/content/ja/rum/showcase.md +++ b/content/ja/rum/showcase.md @@ -34,7 +34,7 @@ APMワークショップでサービスをインストールしました。こ 進行中のシェルスクリプトで環境変数 `RUM_TOKEN` を作成し、デプロイメントをパーソナライズします。 {{< tabpane >}} -{{< tab header="Export Variables" lang="bash" >}} +{{< tab header="Export Variables" lang="sh" >}} export RUM_TOKEN= {{< /tab >}} {{< /tabpane >}} @@ -44,13 +44,13 @@ export RUM_TOKEN= EC2インスタンスのkubernetes（K3s）にOnline Boutiqueのアプリケーションをデプロイするには、元のデプロイメントを削除し、RUM用のapm configスクリプトを実行し、RUMのデプロイメントを適用します。 {{< tabpane >}} -{{< tab header="Deploy Online Boutique with RUM" lang="bash" >}} +{{< tab header="Deploy Online Boutique with RUM" lang="sh" >}} cd ~/workshop/apm kubectl delete -f deployment.yaml ./apm-config.sh -r kubectl apply -f deployment.yaml {{< /tab >}} -{{< tab header="Partial Deployment Output" lang= "bash" >}} +{{< tab header="Partial Deployment Output" lang= "text" >}} ...... Adding RUM_TOKEN to deployment deployment.apps/recommendationservice created diff --git a/go.mod b/go.mod new file mode 100644 index 0000000000..964e5470d1 --- /dev/null +++ b/go.mod @@ -0,0 +1,5 @@ +module github.com/splunk/observability-workshop + +go 1.19 + +require github.com/google/docsy v0.6.0 // indirect diff --git a/go.sum b/go.sum new file mode 100644 index 0000000000..785c595dca --- /dev/null +++ b/go.sum @@ -0,0 +1,5 @@ +github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI= +github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M= +github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= +github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/themes/docsy b/themes/docsy deleted file mode 160000 index f97f4f8f92..0000000000 --- a/themes/docsy +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f97f4f8f92fc606b76d569ce187422f9c675ba7b