### Clone Docsy Example Site and Start Server

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/example-site-as-template.md

Quickly clone the Docsy example site and start a local Hugo server to preview your new site. This is the fastest way to get started.

```bash
git clone --depth 1 --branch v{{% param "version" %}} https://github.com/google/docsy-example.git my-new-site
cd  my-new-site
hugo server
```

--------------------------------

### Start Minikube

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Tutorials/tempo/02-kiali-tempo-integration.md

Starts a local Kubernetes cluster using Minikube. This is a prerequisite for the installation.

```bash
minikube start
```

--------------------------------

### Example Kiali Installation Status Output

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/installation-guide/example-install.md

An example of the status output for a successfully installed Kiali Server, showing conditions, deployment details, environment information, and installation progress. This JSON output is typically obtained after formatting the raw status with a tool like `jq`.

```json
{
  "conditions": [
    {
      "ansibleResult": {
        "changed": 21,
        "completion": "2021-10-20T19:17:35.519131",
        "failures": 0,
        "ok": 102,
        "skipped": 90
      },
      "lastTransitionTime": "2021-10-20T19:17:12Z",
      "message": "Awaiting next reconciliation",
      "reason": "Successful",
      "status": "True",
      "type": "Running"
    }
  ],
  "deployment": {
    "discoverySelectorNamespaces": "bookinfo,istio-system",
    "instanceName": "kiali",
    "namespace": "istio-system"
  },
  "environment": {
    "isKubernetes": true,
    "kubernetesVersion": "1.28.0",
    "operatorVersion": "v1.88.0"
  },
  "progress": {
    "duration": "0:00:14",
    "message": "7. Finished all resource creation"
  }
}
```

--------------------------------

### Run Installation Script

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/adding-content/shortcodes/includes/installation.md

Execute the installation script using sudo privileges. Ensure you have downloaded the installation files first.

```bash
sudo sh install.sh
```

--------------------------------

### Serve Local Docsy User Guide

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/README.md

Clone the Docsy repository, navigate to the userguide directory, install npm dependencies, and serve the local copy of the documentation.

```sh
git clone --depth 1 https://github.com/google/docsy.git
cd docsy/userguide/
npm install
npm run serve
```

--------------------------------

### Example Detection Output

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/news/security-bulletins/KIALI-SECURITY-001.md

This is an example of the output you might see when running the detection script, indicating a vulnerable Kiali installation.

```bash
Your Kiali version found: 1.14.0
Your Kiali version is vulnerable
Your Kiali configuration looks vulnerable
```

--------------------------------

### Configure Kiali Server Web Root via Helm

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/installation-guide/install-with-helm.md

Example of how to configure a specific setting, like the Kiali server's web root path, using the --set flag during Helm installation. This demonstrates passing Kiali CR settings as Helm chart values.

```bash
$ helm install --set cr.spec.server.web_root=/your-path kiali-operator kiali/kiali-operator
```

--------------------------------

### Download and Install Bookinfo Demo

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Tutorials/tempo/02-kiali-tempo-integration.md

Download, make executable, and run the bookinfo demo installation script. This script sets up the Bookinfo application and generates traffic.

```bash
curl -L -o install-bookinfo.sh https://raw.githubusercontent.com/kiali/kiali/master/hack/istio/install-bookinfo-demo.sh
chmod +x install-bookinfo.sh
./install-bookinfo.sh -c kubectl -tg -id ${ISTIO_DIR}
```

--------------------------------

### Install Kiali with Tempo Integration

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Tutorials/tempo/02-kiali-tempo-integration.md

Install Kiali using Helm, configuring it to use Tempo for tracing. Set internal and external URLs for Tempo.

```bash
helm install \
    --namespace istio-system \
    --set external_services.tracing.internal_url=http://tempo-smm-query-frontend.tempo:16685 \
    --set external_services.tracing.external_url=http://localhost:16686 \
    --set auth.strategy=anonymous \
    kiali-server \
    kiali/kiali-server
```

--------------------------------

### Install Kiali Operator and Server with Helm

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/installation-guide/install-with-helm.md

Installs the Kiali Operator and a Kiali CR in the 'istio-system' namespace using the 'kiali/kiali-operator' Helm chart. This is the recommended installation method. It configures anonymous authentication for initial access and creates the 'kiali-operator' namespace if it doesn't exist.

```bash
$ helm install \
    --set cr.create=true \
    --set cr.namespace=istio-system \
    --set cr.spec.auth.strategy="anonymous" \
    --namespace kiali-operator \
    --create-namespace \
    kiali-operator \
    kiali/kiali-operator
```

--------------------------------

### Verify Kiali Permissions Script Usage

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Configuration/multi-cluster/_index.md

This example demonstrates how to download, make executable, and run the `verify-kiali-permissions.sh` script to check Kiali's access permissions on a remote cluster. Adjust the arguments based on your specific setup.

```bash
curl -L -o verify-kiali-permissions.sh https://raw.githubusercontent.com/kiali/kiali/master/hack/istio/multicluster/verify-kiali-permissions.sh
chmod +x verify-kiali-permissions.sh
./verify-kiali-permissions.sh --kubeconfig-secret istio-system:kiali-multi-cluster-secret:my-cluster-name --kiali-version v2.10.0
```

--------------------------------

### Hugo Build Output Example

Source: https://github.com/kiali/kiali.io/blob/staging/README.md

Example output from the Hugo build process, showing statistics and server availability.

```text
                   | EN
-------------------+------
  Pages            | 151
  Paginator pages  |   0
  Non-page files   |   1
  Static files     | 323
  Processed images |   2
  Aliases          |   4
  Sitemaps         |   1
  Cleaned          |   0

Built in 1313 ms
Environment: "development"
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 0.0.0.0)
Press Ctrl+C to stop
```

--------------------------------

### Example package.json for PostCSS Dependencies

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/deployment/_index.md

Ensure your package.json includes PostCSS and postcss-cli if you need specific versions. This is crucial for Netlify's dependency installation.

```json
  "devDependencies": {
    "autoprefixer": "^9.8.8",
    "postcss-cli": "^8.0.0",
    "postcss": "^8.0.0"
  }
```

--------------------------------

### Install Hugo

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/installation-prerequisites.md

Install the Hugo executable to the system's binary path.

```bash
sudo install hugo /usr/bin
```

--------------------------------

### Install Kiali Server with Helm Chart and Values File

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/FAQ/installation.md

Install or upgrade the Kiali Server using the Helm chart, providing a custom values file that references the secret for authentication.

```bash
helm install -f my-values.yaml -n istio-system kiali-server kiali/kiali-server
```

--------------------------------

### Install Istio with Tempo Tracing via Kiali Script

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Tutorials/tempo/02-kiali-tempo-integration.md

Use Kiali's hack scripts to install Istio with Tempo tracing enabled. This is useful for development environments.

```bash
hack/istio/install-istio-via-istioctl.sh -c kubectl -a "prometheus grafana" -s values.meshConfig.defaultConfig.tracing.zipkin.address="tempo-smm-distributor.tempo:9411"
```

--------------------------------

### Install Kiali with Helm

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Tutorials/multicluster/05-Install-Kiali.md

Installs the Kiali server using Helm, configuring it for anonymous authentication, debug logging, and ingress enablement. Ensure the correct context is set before running.

```bash
kubectl config use-context $CLUSTER_EAST

helm upgrade --install --namespace istio-system --set auth.strategy=anonymous --set deployment.logger.log_level=debug --set deployment.ingress.enabled=true --repo https://kiali.org/helm-charts kiali-server kiali-server 
```

--------------------------------

### Install Standalone Kiali Server

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/installation-guide/install-with-helm.md

Install the Kiali Server directly using the `kiali-server` Helm chart without the operator. This method is suitable for simpler deployments.

```bash
$ helm install \
    --namespace istio-system \
    kiali-server \
    kiali/kiali-server
```

--------------------------------

### Page Front Matter Examples

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/adding-content/navigation.md

Examples of front matter configurations for setting page titles, weights, and descriptions in TOML, YAML, and JSON formats.

```toml
+++
title = "Navigation and Search"
linkTitle = "Navigation and Search"
date = 2017-01-05T00:00:00.000Z
weight = 3
description = '''
Customize site navigation and search for your Docsy site.
'''
+++
```

```yaml
---
title: "Navigation and Search"
linkTitle: "Navigation and Search"
date: 2017-01-05
weight: 3
description: >
  Customize site navigation and search for your Docsy site.
---
```

```json
{
  "title": "Navigation and Search",
  "linkTitle": "Navigation and Search",
  "date": "2017-01-05T00:00:00.000Z",
  "weight": 3,
  "description": "Customize site navigation and search for your Docsy site.\n"
}
```

--------------------------------

### Install Kiali via Helm

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/quick-start.md

Installs the latest version of Kiali Server into the 'istio-system' namespace using Helm v3. This command configures anonymous authentication.

```bash
helm install \
  --namespace istio-system \
  --set auth.strategy="anonymous" \
  --repo https://kiali.org/helm-charts \
  kiali-server \
  kiali-server
```

--------------------------------

### Install Prometheus Addon

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Tutorials/multicluster/04-Install-Istio-east-cluster.md

Installs Prometheus on the east cluster within the 'istio-system' namespace. Prometheus is a required component for Kiali to function correctly.

```bash
kubectl --context $CLUSTER_EAST -n istio-system apply -f $ISTIO_DIR/samples/addons/prometheus.yaml
```

--------------------------------

### Verify Kiali Installation

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Tutorials/multicluster/05-Install-Kiali.md

Accesses the Kiali dashboard via the istioctl command-line tool to confirm the installation was successful. This command opens the Kiali UI in your default browser.

```bash
istioctl dashboard kiali
```

--------------------------------

### Start Minikube Cluster

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Tutorials/multicluster/03-Deploy-east-cluster.md

Starts a new minikube cluster named '$CLUSTER_EAST' with specified network, memory, and CPU resources. This command is used to provision the primary 'East' cluster.

```bash
minikube start -p $CLUSTER_EAST --network istio --memory 8g --cpus 4

```

--------------------------------

### Prepare Remote Cluster Script Example

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Configuration/multi-cluster/_index.md

This example shows how to download, make executable, and run the `kiali-prepare-remote-cluster.sh` script to simplify the creation of Kiali Service Accounts, roles, role-bindings, and kubeconfig secrets for remote clusters. The `--process-kiali-secret true` option is crucial for creating the secret.

```bash
curl -L -o kiali-prepare-remote-cluster.sh https://raw.githubusercontent.com/kiali/kiali/master/hack/istio/multicluster/kiali-prepare-remote-cluster.sh
chmod +x kiali-prepare-remote-cluster.sh
./kiali-prepare-remote-cluster.sh --kiali-cluster-context east --remote-cluster-context west --view-only false --process-kiali-secret true --process-remote-resources true
```

--------------------------------

### Install Hugo Extended on Linux

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/other-options.md

Install the extended version of Hugo from the release page on Linux. This method ensures you get the necessary features like SCSS support.

```bash
mkdir hugo
cd hugo
sudo install hugo /usr/bin
```

--------------------------------

### Docsy NPM Install Side-effect Example

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/other-options.md

Illustrates the creation of a 'github.com' sibling folder when 'npm install' is run inside the Docsy theme directory, a workaround for Hugo module support.

```console
$ ls themes
docsy                   github.com
```

--------------------------------

### Start Hugo Server

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/example-site-as-template.md

Navigate to your cloned project directory and run the Hugo server command to build and preview your site locally. Changes are reflected in real-time.

```bash
cd my-new-site
hugo server
```

--------------------------------

### Get Kiali Installation Status

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/installation-guide/example-install.md

Retrieves the status of a Kiali Server installation by querying its Kiali Custom Resource (CR) in JSON format. This is useful for monitoring the deployment progress and verifying successful completion.

```bash
kubectl get kiali kiali -n istio-system -o jsonpath='{.status}'
```

--------------------------------

### Get Kiali Logs

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Configuration/debugging-kiali.md

Basic command to retrieve logs from the Kiali deployment. Ensure the namespace is correct if Kiali is not installed in `istio-system`.

```bash
kubectl logs -n istio-system deployment/kiali
```

--------------------------------

### Start MCP Server with Kiali Toolset

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/AI/kiali-mcp.md

Launch the MCP server, providing your configuration file and optionally specifying read-only mode. This makes the Kiali toolset available to connected clients.

```bash
kubernetes-mcp-server --config /path/to/config.toml --read-only
```

--------------------------------

### Example OSSMConsole CR

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Configuration/ossmconsoles.kiali.io.md

This is an example of the OSSMConsole Custom Resource (CR) definition. It shows the default values for configuring the OSSM Console plugin, including image details, pull secrets, and Kiali service information. Modify these fields to customize the installation.

```yaml
apiVersion: kiali.io/v1alpha1
kind: OSSMConsole
metadata:
  name: ossmconsole
  annotations:
    ansible.sdk.operatorframework.io/verbosity: "1"
spec:
  version: "default"

  deployment:
    imageDigest: ""
    imageName: ""
    imagePullPolicy: "IfNotPresent"
    # default: image_pull_secrets is an empty list
    imagePullSecrets: ["image.pull.secret"]
    imageVersion: ""
    namespace: ""

  kiali:
    serviceName: ""
    serviceNamespace: ""
    servicePort: 0
```

--------------------------------

### Build and Preview Site Locally

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md

Run this command in your project's root directory to build and preview your site locally. The site will be available at http://localhost:1313/ by default.

```bash
hugo server
```

--------------------------------

### Configure Prometheus URL

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Configuration/p8s-jaeger-grafana/prometheus.md

Manually provide the endpoint URL if your Prometheus instance has a different service name or is installed in a different namespace than the default. This example sets the URL to 'http://metrics.telemetry:9090/'.

```yaml
spec:
  external_services:
    prometheus:
      # Prometheus service name is "metrics" and is in the "telemetry" namespace
      url: "http://metrics.telemetry:9090/"
```

--------------------------------

### Install Kiali Server with Custom Web FQDN

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/installation-guide/install-with-helm.md

Configure the Kiali Server during installation by setting chart values, such as `server.web_fqdn`, using the `--set` flag. This allows customization of Kiali's fully qualified domain name.

```bash
$ helm install \
    --namespace istio-system \
    --set server.web_fqdn=example.com \
    kiali-server \
    kiali/kiali-server
```

--------------------------------

### Initialize Site as Hugo Module

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md

Command to turn an existing Hugo site into a Hugo Module, creating go.mod and go.sum files.

```Bash
hugo mod init github.com/me/my-new-site
```

--------------------------------

### Get Kiali API Version Information

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/FAQ/general.md

Use `curl` to retrieve Kiali version details in JSON format from the `/api` endpoint. Ensure Kiali is accessible, for example, via `kubectl port-forward`.

```bash
kubectl port-forward -n istio-system deploy/kiali 20001:20001
```

```bash
curl http://localhost:20001/kiali/api
```

--------------------------------

### Change Directory to Docsy Example

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/quickstart-docker.md

Navigate into the cloned docsy-example repository directory.

```bash
cd docsy-example
```

--------------------------------

### Install Docsy as NPM Package

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/other-options.md

Installs Docsy and related packages as development dependencies. Ensure to also install autoprefixer and postcss-cli.

```console
npm install --save-dev google/docsy#semver:{{% param version %}} autoprefixer postcss-cli
```

--------------------------------

### Install Kiali Operator Only

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/installation-guide/install-with-helm.md

Use this command to install only the Kiali Operator, omitting the Kiali CR creation. This is useful for advanced customization of the Kiali installation.

```bash
$ helm install \
    --namespace kiali-operator \
    --create-namespace \
    kiali-operator \
    kiali/kiali-operator
```

--------------------------------

### Serve Kiali.io Website Locally with Docker

Source: https://github.com/kiali/kiali.io/blob/staging/README.md

When using Docker, set the DORP environment variable to 'docker' to serve the website locally.

```bash
make -e DORP=docker serve
```

--------------------------------

### Apply Kiali CR and Create Namespace

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/installation-guide/example-install.md

Apply the Kiali CR to deploy the server and create the necessary namespace. Ensure the namespace exists before applying the CR.

```bash
$ kubectl create namespace kialianon
$ kubectl apply -f kiali-cr-anon.yaml
```

--------------------------------

### Install PostCSS Dependencies

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/README.md

Install Autoprefixer and PostCSS CLI as development dependencies. Ensure PostCSS is also installed if using version 8 or later of postcss-cli.

```sh
npm install --save-dev autoprefixer
npm install --save-dev postcss-cli
```

```sh
npm install -D postcss
```

--------------------------------

### Install Docsy Dependencies

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/other-options.md

Installs Node.js dependencies for the Docsy theme.

```sh
(cd themes/docsy && npm install)
```

--------------------------------

### Run Kiali Locally

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/quick-start.md

Starts the Kiali backend server on localhost and opens the Kiali UI in your default browser. This command is useful for local development and testing.

```bash
kiali run
```

--------------------------------

### Install Cert-Manager

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Tutorials/tempo/02-kiali-tempo-integration.md

Installs cert-manager, a Kubernetes certificate authority. This is required for managing certificates.

```bash
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.12.0/cert-manager.yaml
```

--------------------------------

### Initialize Hugo Site and Add Docsy Module (Windows)

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md

Commands to create a new Hugo site, initialize it as a module, get the Docsy module, and configure it in hugo.toml using Windows command line.

```Batchfile
hugo new site my-new-site
cd  my-new-site
hugo mod init github.com/me/my-new-site
hugo mod get github.com/google/docsy@v{{% param "version" %}}
(echo [module]^^

proxy = "direct"^^

[[module.imports]]^^

path = "github.com/google/docsy"
hugo server
```

--------------------------------

### Install PostCSS

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/installation-prerequisites.md

Install PostCSS as a development dependency. This is required for PostCSS versions 8 and later.

```bash
npm install -D postcss
```

--------------------------------

### Install PostCSS Dependencies

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/installation-prerequisites.md

Install Autoprefixer and PostCSS CLI as development dependencies using npm.

```bash
npm install -D autoprefixer
npm install -D postcss-cli
```

--------------------------------

### List Helm Installations

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/installation-guide/install-with-helm.md

Use `helm list` to view existing Helm installations in a specific namespace.

```bash
$ helm list -n kiali-operator
NAME            NAMESPACE       REVISION        UPDATED                                 STATUS          CHART                   APP VERSION
kiali-operator  kiali-operator  1               2021-09-14 18:00:45.320351026 -0500 CDT deployed        kiali-operator-1.40.0   v1.40.0
```

--------------------------------

### Verify ACM Observability Installation

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Configuration/multi-cluster/acm-observability.md

Check if the ACM Observability operator is installed and running on the hub cluster.

```bash
oc get mco observability
```

--------------------------------

### Create and Deploy Travel Demo Namespaces and Applications

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Tutorials/travels/02-install-travel-demo.md

Use these commands to create the necessary namespaces and apply the application manifests for the Travel Demo. OpenShift users should substitute `oc` for `kubectl` and ensure NetworkAttachmentDefinitions and SecurityContextConstraints are configured.

```bash
kubectl create namespace travel-agency
kubectl create namespace travel-portal
kubectl create namespace travel-control

kubectl apply -f <(curl -L https://raw.githubusercontent.com/kiali/demos/master/travels/travel_agency.yaml) -n travel-agency
kubectl apply -f <(curl -L https://raw.githubusercontent.com/kiali/demos/master/travels/travel_portal.yaml) -n travel-portal
kubectl apply -f <(curl -L https://raw.githubusercontent.com/kiali/demos/master/travels/travel_control.yaml) -n travel-control
```

--------------------------------

### Install Node.js on Debian/Ubuntu

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/installation-prerequisites.md

Use these commands to install Node.js version 20.x on Debian and Ubuntu based distributions.

```bash
# Using Ubuntu
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs

# Using Debian, as root
curl -fsSL https://deb.nodesource.com/setup_20.x | bash -
apt-get install -y nodejs

```

--------------------------------

### Preview Site Locally with Hugo Server

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/other-options.md

Use this command to start a local Hugo server for previewing your site. Ensure you are in your project directory.

```sh
cd myproject
hugo server
```

--------------------------------

### Serve Docsy User Guide Locally

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/contribution-guidelines/_index.md

Build and serve the Docsy user guide locally using Hugo. This command is used after navigating to the userguide directory and requires the themesDir flag because the site files are within the theme repository.

```bash
cd userguide
hugo server --themesDir ../..
```

--------------------------------

### Install Hugo Extended as npm Module

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/installation-prerequisites.md

Install the extended version of Hugo as a development dependency using npm.

```bash
npm install hugo-extended --save-dev
```

--------------------------------

### Specify Kiali Installation Namespace

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/deployment-options.md

Configure a custom namespace for Kiali installation if it differs from the Kiali CR namespace.

```yaml
spec:
  deployment:
    namespace: "custom-kiali-namespace"
```

--------------------------------

### Initialize Hugo Site and Add Docsy Module (Unix)

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md

Commands to create a new Hugo site, initialize it as a module, get the Docsy module, and configure it in hugo.toml using Unix shell.

```Bash
hugo new site my-new-site
cd  my-new-site
hugo mod init github.com/me/my-new-site
hugo mod get github.com/google/docsy@v{{% param "version" %}}
cat >> hugo.toml <<EOL
[module]
proxy = "direct"
[[module.imports]]
path = "github.com/google/docsy"
EOL
hugo server
```

--------------------------------

### Hello World in Multiple Languages

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/adding-content/shortcodes/index.md

Demonstrates the use of the `tabpane` shortcode to display equivalent 'Hello World!' code snippets in various programming languages.

```C
#include <stdio.h>
#include <stdlib.h>

int main(void)
{
  puts("Hello World!");
  return EXIT_SUCCESS;
}
```

```C++
#include <iostream>

int main()
{
  std::cout << "Hello World!" << std::endl;
}
```

```Go
package main
import "fmt"
func main() {
  fmt.Printf("Hello World!\n")
}
```

```Java
class HelloWorld {
  static public void main( String args[] ) {
    System.out.println( "Hello World!" );
  }
}
```

```Kotlin
fun main(args : Array<String>) {
    println("Hello, world!")
}
```

```Lua
print "Hello world"
```

```PHP
<?php
echo 'Hello World!';
?>
```

```Python
print("Hello World!")
```

```Ruby
puts "Hello World!"
```

```Scala
object HelloWorld extends App {
  println("Hello world!")
}
```

--------------------------------

### Install Node.js on Enterprise Linux

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/get-started/docsy-as-module/installation-prerequisites.md

Use these commands to install Node.js version 20.x on Enterprise Linux based distributions.

```bash
# As root
curl -fsSL https://rpm.nodesource.com/setup_20.x | bash -

# No root privileges
curl -fsSL https://rpm.nodesource.com/setup_20.x | sudo bash -

```

--------------------------------

### Initialize Hugo Module

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/updating/convert-site-to-module.md

Run this command in your site's root directory to turn your existing site into a Hugo Module. This creates go.mod and go.sum files.

```Bash
cd /path/to/my-existing-site
hugo mod init github.com/me/my-existing-site
```

--------------------------------

### Get Kiali Run Help

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Installation/quick-start.md

Displays the full list of options available for the 'kiali run' command, allowing for customization of the local Kiali instance.

```bash
kiali run --help
```

--------------------------------

### Install Tempo Operator

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Tutorials/tempo/02-kiali-tempo-integration.md

Installs the Grafana Tempo operator. Ensure you use version 3.0 or higher for full functionality.

```bash
kubectl apply -f https://github.com/grafana/tempo-operator/releases/download/v0.3.0/tempo-operator.yaml
```

--------------------------------

### PlantUML Use Case Diagram Example

Source: https://github.com/kiali/kiali.io/blob/staging/themes/docsy/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md

This is an example of a PlantUML use case diagram. It defines various participants and their interactions.

```plantuml
participant participant as Foo
actor       actor       as Foo1
boundary    boundary    as Foo2
control     control     as Foo3
entity      entity      as Foo4
database    database    as Foo5
collections collections as Foo6
queue       queue       as Foo7
Foo -> Foo1 : To actor
Foo -> Foo2 : To boundary
Foo -> Foo3 : To control
Foo -> Foo4 : To entity
Foo -> Foo5 : To database
Foo -> Foo6 : To collections
Foo -> Foo7: To queue
```

--------------------------------

### Configure Multiple AI Providers

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/AI/kiali-chatbot.md

Example configuration showing how to enable and configure OpenAI, Google, and Anthropic AI providers, including default models, API keys, and tool exposure.

```yaml
chat_ai:
  enabled: true
  default_provider: "openai"
  tools:
    disabled_tools:
      - "manage_istio_config"
  providers:
    - name: "openai"
      enabled: true
      description: "OpenAI provider"
      type: "openai"
      config: "default"
      default_model: "gpt"
      tools:
        enabled_tools:
          - "get_logs"
          - "get_mesh_status"
          - "list_traces"
      models:
        - name: "gpt"
          enabled: true
          model: "<openai-model-name>"
          key: "secret:my-key-secret:openai-api-key"
    - name: "google"
      enabled: true
      description: "Google provider"
      type: "google"
      config: "gemini"
      default_model: "gemini"
      models:
        - name: "gemini"
          enabled: true
          model: "gemini-2.5-pro"
          description: "Model provided by Google with OpenAI API Support"
          endpoint: "https://generativelanguage.googleapis.com/v1beta/openai"
          key: "secret:my-key-secret:google-api-key"
    - name: "anthropic"
      enabled: true
      description: "Anthropic provider"
      type: "anthropic"
      config: "default"
      default_model: "claude-haiku"
      key: "secret:my-key-secret:claude-api-key"
      models:
        - name: claude-sonnet
          model: "claude-sonnet-4-5"
          enabled: true
          endpoint: "https://api.anthropic.com/"
        - name: claude-haiku
          model: "claude-haiku-4-5"
          enabled: true
```

--------------------------------

### Prepare Remote Cluster Script with Operator

Source: https://github.com/kiali/kiali.io/blob/staging/content/en/docs/Configuration/multi-cluster/_index.md

This example demonstrates using the `kiali-prepare-remote-cluster.sh` script when the remote cluster resources were created by the Kiali Operator. It specifies `--process-remote-resources false` and uses `--kiali-resource-name` to point to the Operator-created Service Account.

```bash
./kiali-prepare-remote-cluster.sh \
  --kiali-cluster-context east \
  --remote-cluster-context west \
  --kiali-resource-name kiali-service-account \
  --process-remote-resources false \
  --process-kiali-secret true \
  --view-only false
```