### Start UI Dev Mode with Install - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Installs dependencies and starts the UI application in development mode. Use this command for the initial setup or when dependencies might be missing.

```Shell
pnpm start:ci
```

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

### Start UI Dev Mode - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Starts the UI application in development mode without reinstalling dependencies. Use this if dependencies are already installed (e.g., via `pnpm install --frozen-lockfile`).

```Shell
pnpm start
```

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

### Installing Rootless Containerd

Source: https://github.com/hystax/optscale/blob/integration/README.md

Command suggested by error messages to install and potentially start rootless containerd, which is required for nerdctl to function correctly in a rootless environment.

```bash
containerd-rootless-setuptool.sh install
```

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

### Run Server Serving UI - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Starts the server component configured to serve the previously built UI application. Requires the `UI_BUILD_PATH` environment variable to be set, pointing to the UI build directory.

```Shell
pnpm start
```

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

### Install Server Dependencies - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Installs all required dependencies for the server component of the project using pnpm. This command should be run in the server's root directory.

```Shell
pnpm install
```

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

### Run Server in Development Mode - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Starts the server component of the project in development mode. Ensure dependencies are installed and environment variables are set before running.

```Shell
pnpm start
```

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

### Prepare Python Virtual Environment

Source: https://github.com/hystax/optscale/blob/integration/README.md

Creates a Python 3 virtual environment, activates it, and installs dependencies from requirements.txt using pip.

```bash
virtualenv -p python3 .venv
source .venv/bin/activate
pip install -r requirements.txt
```

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

### Start OptScale Cluster with runkube.py (Default)

Source: https://github.com/hystax/optscale/blob/integration/README.md

Executes the runkube.py script to deploy the OptScale cluster with ELK stack, using a user overlay and specifying deployment name and version.

```bash
./runkube.py --with-elk  -o overlay/user_template.yml -- <deployment name> <version>
```

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

### Install Required Packages with apt

Source: https://github.com/hystax/optscale/blob/integration/README.md

Installs necessary system packages including python3, pip, git, sshpass, and virtual environment tools using apt.

```bash
sudo apt update; sudo apt install python3-pip sshpass git python3-virtualenv python3 python3-venv python3-dev -y
```

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

### Generate Jira App Descriptor URL (Example)

Source: https://github.com/hystax/optscale/blob/integration/jira_ui/README.md

Shows a concrete example of the URL used to invoke the OptScale API endpoint for generating the 'atlassian-connect.json' app descriptor, using specific example hostnames for illustration.

```HTTP
https://dev-2.optscale.com/jira_bus/v2/app_descriptor?base_host=bb5a163ef415.ngrok.io
```

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

### Start OptScale Cluster with runkube.py (Socket)

Source: https://github.com/hystax/optscale/blob/integration/README.md

Executes the runkube.py script to deploy the OptScale cluster with ELK stack using a socket connection, a user overlay, and specifying deployment name and version.

```bash
./runkube.py --use-socket --with-elk  -o overlay/user_template.yml -- <deployment name> <version>
```

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

### Start OptScale Cluster with runkube.py (Local Images)

Source: https://github.com/hystax/optscale/blob/integration/README.md

Executes the runkube.py script to deploy the OptScale cluster with ELK stack using locally built images, a user overlay, and specifying deployment name and 'local' version.

```bash
./runkube.py --with-elk --no-pull -o overlay/user_template.yml -- <deployment name> local
```

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

### Install Dependencies with Override - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Installs project dependencies, applying any overrides defined in package.json. Use this after generating an override to test the fix.

```Shell
pnpm install
```

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

### Sourcing User Profile

Source: https://github.com/hystax/optscale/blob/integration/README.md

Command to re-read and apply the user's profile script, which often sets environment variables and paths necessary for tools like containerd or nerdctl after installation or setup. This can resolve 'rootless containerd not running' errors.

```bash
source ~/.profile
```

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

### Clone OptScale Repository with Git

Source: https://github.com/hystax/optscale/blob/integration/README.md

Clones the OptScale project repository from GitHub to the local machine.

```bash
git clone https://github.com/hystax/optscale.git
```

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

### Start OptScale Cluster with runkube.py (Insecure Registry)

Source: https://github.com/hystax/optscale/blob/integration/README.md

Executes the runkube.py script to deploy the OptScale cluster with ELK stack, allowing connections to an insecure container registry, using a user overlay, and specifying deployment name and version.

```bash
./runkube.py --insecure --with-elk  -o overlay/user_template.yml -- <deployment name> <version>
```

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

### Running Kubernetes Setup Script

Source: https://github.com/hystax/optscale/blob/integration/README.md

Command to execute a Python script (`runkube.py`) likely involved in setting up or interacting with a Kubernetes environment. The specific arguments are omitted in the text. This command can also fail due to rootless containerd issues.

```bash
./runkube.py... <>
```

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

### Install pnpm Globally - Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Installs the pnpm package manager globally on your system using npm. This is a prerequisite for managing project dependencies.

```Shell
npm install -g pnpm
```

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

### Build UI for Server Serving - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Builds the production version of the UI application. This build can then be served by the server component. Run this from the UI project directory (ngui/ui).

```Shell
pnpm build
```

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

### Start Updated Cluster Example (Shell)

Source: https://github.com/hystax/optscale/blob/integration/documentation/update_to_24.04.md

An example of starting the updated Optscale cluster with a specific release name ('os-1') and using the locally built version ('local').

```Shell
./runkube.py --no-pull --with-elk  -o overlay/user_template.yml -- os-1 local
```

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

### Change Directory to OptScale Deploy

Source: https://github.com/hystax/optscale/blob/integration/README.md

Navigates into the optscale-deploy directory within the cloned repository.

```bash
cd optscale/optscale-deploy
```

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

### Build Local OptScale Images

Source: https://github.com/hystax/optscale/blob/integration/README.md

Changes directory and executes the build script to create local OptScale container images using nerdctl.

```bash
cd .. && ./build.sh --use-nerdctl
```

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

### Install Kubernetes Master with Ansible

Source: https://github.com/hystax/optscale/blob/integration/README.md

Runs an Ansible playbook to install the Kubernetes master node on a specified remote host using SSH. Requires user and IP address parameters.

```bash
ansible-playbook -e "ansible_ssh_user=<user>" -k -K -i "<ip address>," ansible/k8s-master.yaml
```

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

### Start UI Development Server

Source: https://github.com/hystax/optscale/blob/integration/jira_ui/README.md

Changes the current directory to 'ui' and then initiates the frontend development server using npm. By default, this server is configured to run on port 3001.

```Shell
cd ui && npm start
```

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

### Running Build Script with Nerdctl

Source: https://github.com/hystax/optscale/blob/integration/README.md

Command used to build project components using the `build.sh` script, specifically enabling the use of nerdctl. This command might fail if rootless containerd is not running.

```bash
build.sh --use-nerdctl
```

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

### Install nginx-ingress Helm Chart (TL;DR) Console

Source: https://github.com/hystax/optscale/blob/integration/optscale-deploy/ansible/roles/k8s-configure/files/nginx-ingress/README.md

Provides a quick command to install the nginx-ingress Helm chart using default settings.

```console
$ helm install stable/nginx-ingress
```

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

### Source User Profile

Source: https://github.com/hystax/optscale/blob/integration/README.md

Reloads the user's profile to update environment variables, typically adding local binary paths to the system PATH.

```bash
source ~/.profile
```

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

### Check Kubernetes Pod Status with kubectl

Source: https://github.com/hystax/optscale/blob/integration/README.md

Uses kubectl to list all pods in the current Kubernetes cluster and check their status.

```bash
kubectl get pods
```

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

### Example: Backup Docker Image (Docker)

Source: https://github.com/hystax/optscale/blob/integration/documentation/howto_patch_pod.md

Provides a concrete example of how to backup the 'rest_api' Docker image using the tag command.

```bash
docker tag rest_api:local rest_api:backup
```

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

### Identify Vulnerable Dependency Path - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Shows the dependency path leading to a specified vulnerable package. Use this to understand why a particular vulnerable package is included in your project.

```Shell
pnpm why <package_name>
```

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

### Edit Nginx Ingress Controller Daemonset

Source: https://github.com/hystax/optscale/blob/integration/README.md

Provides the `kubectl` command to open the daemonset configuration for editing, allowing modification of its parameters.

```Shell
$ kubectl edit daemonset ngingress-nginx-ingress-controller
```

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

### Example: Backup Nerdctl Image (Nerdctl)

Source: https://github.com/hystax/optscale/blob/integration/documentation/howto_patch_pod.md

Provides a concrete example of how to backup the 'rest_api' Nerdctl image using the tag command.

```bash
nerdctl tag rest_api:local rest_api:backup
```

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

### Update OptScale Cluster with runkube.py

Source: https://github.com/hystax/optscale/blob/integration/README.md

Executes the runkube.py script to update an existing OptScale cluster with ELK stack, specifying the deployment name and target version.

```bash
./runkube.py --with-elk  --update-only -- <deployment name>  <version>
```

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

### Expose Local Server with ngrok

Source: https://github.com/hystax/optscale/blob/integration/jira_ui/README.md

Uses the ngrok tool to create a secure tunnel from a public URL to the local development server running on port 3001. This makes the locally hosted application accessible to the Jira Cloud instance for installation and testing.

```Shell
ngrok http 3001
```

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

### Install Config Client in Editable Mode

Source: https://github.com/hystax/optscale/blob/integration/gemini/gemini_scheduler/requirements.txt

Installs the optscale_client/config_client package from a local path in editable mode, useful for development.

```requirements.txt
-e optscale_client/config_client
```

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

### Nginx Ingress Controller Resource Limits Configuration

Source: https://github.com/hystax/optscale/blob/integration/README.md

Shows the YAML structure within the daemonset configuration where resource limits and requests for memory are defined. This section is targeted for modification to resolve resource-related issues.

```YAML
resources:
  limits:
    memory: 384Mi
  requests:
    memory: 192Mi
```

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

### Install REST API Client in Editable Mode

Source: https://github.com/hystax/optscale/blob/integration/gemini/gemini_scheduler/requirements.txt

Installs the optscale_client/rest_api_client package from a local path in editable mode, useful for development.

```requirements.txt
-e optscale_client/rest_api_client
```

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

### Get Nginx Ingress Service IP with kubectl

Source: https://github.com/hystax/optscale/blob/integration/README.md

Uses kubectl to retrieve the service details for the nginx ingress controller, typically to find the external IP or hostname for accessing the cluster.

```bash
kubectl get services --field-selector metadata.name=ngingress-nginx-ingress-controller
```

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

### Resetting Kubernetes Cluster

Source: https://github.com/hystax/optscale/blob/integration/README.md

Command using `kubeadm` to forcefully reset the Kubernetes control plane and worker nodes on a machine. This is used to clean up a failed installation attempt before retrying. Requires superuser privileges.

```bash
sudo kubeadm reset -f
```

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

### Install OptScale Config Client (Editable) (Python)

Source: https://github.com/hystax/optscale/blob/integration/docker_images/booking_observer/requirements.txt

Specifies installing the OptScale configuration client package in editable mode from a local path.

```Python
-e optscale_client/config_client
```

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

### Install REST API Client Locally - Python

Source: https://github.com/hystax/optscale/blob/integration/docker_images/run_observer/requirements.txt

Installs the local 'optscale_client/rest_api_client' package in editable mode ('-e'), facilitating development and testing.

```Python
-e optscale_client/rest_api_client
```

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

### Check npm Module Vulnerabilities - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Performs a basic audit of project dependencies to identify known security vulnerabilities. This command reports vulnerabilities without attempting fixes.

```Shell
pnpm audit
```

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

### Install OptScale Time Tool (Editable) (Python)

Source: https://github.com/hystax/optscale/blob/integration/docker_images/booking_observer/requirements.txt

Specifies installing the OptScale time tool package in editable mode from a local path.

```Python
-e tools/optscale_time
```

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

### Get NodePort Access URL (Shell)

Source: https://github.com/hystax/optscale/blob/integration/optscale-deploy/ansible/roles/k8s-configure/files/nginx-ingress/templates/NOTES.txt

Commands to determine the NodePort and Node IP for accessing the application when the controller service type is NodePort. Includes Helm templating logic to get ports from chart values or by querying Kubernetes services.

```Shell
{{- if (not (empty .Values.controller.service.nodePorts.http)) }}
  export HTTP_NODE_PORT={{ .Values.controller.service.nodePorts.http }}
{{- else }}
  export HTTP_NODE_PORT=$(kubectl --namespace {{ .Release.Namespace }} get services -o jsonpath="{.spec.ports[0].nodePort}" {{ template "nginx-ingress.controller.fullname" . }})
{{- end }}
{{- if (not (empty .Values.controller.service.nodePorts.https)) }}
  export HTTPS_NODE_PORT={{ .Values.controller.service.nodePorts.https }}
{{- else }}
  export HTTPS_NODE_PORT=$(kubectl --namespace {{ .Release.Namespace }} get services -o jsonpath="{.spec.ports[1].nodePort}" {{ template "nginx-ingress.controller.fullname" . }})
{{- end }}
  export NODE_IP=$(kubectl --namespace {{ .Release.Namespace }} get nodes -o jsonpath="{.items[0].status.addresses[1].address}")

  echo "Visit http://$NODE_IP:$HTTP_NODE_PORT to access your application via HTTP."
  echo "Visit https://$NODE_IP:$HTTPS_NODE_PORT to access your application via HTTPS."
```

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

### Specify Editable Install for REST API Client (Python)

Source: https://github.com/hystax/optscale/blob/integration/docker_images/layout_cleaner/requirements.txt

Specifies an editable installation for the `optscale_client/rest_api_client` package, commonly used during development to link the installed package directly to the source code directory. This enables developers to modify the source code and see the changes immediately without needing to re-install.

```Python
-e optscale_client/rest_api_client
```

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

### Install nginx-ingress Helm Chart with Release Name Console

Source: https://github.com/hystax/optscale/blob/integration/optscale-deploy/ansible/roles/k8s-configure/files/nginx-ingress/README.md

Installs the nginx-ingress Helm chart with a specified release name, deploying it in the default configuration.

```console
$ helm install --name my-release stable/nginx-ingress
```

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

### Example Ingress Resource (YAML)

Source: https://github.com/hystax/optscale/blob/integration/optscale-deploy/ansible/roles/k8s-configure/files/nginx-ingress/templates/NOTES.txt

An example Kubernetes Ingress resource definition that uses the nginx-ingress controller to route traffic for a specific host to a backend service. Includes optional TLS configuration referencing a Secret.

```YAML
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  annotations:
    kubernetes.io/ingress.class: {{ .Values.controller.ingressClass }}
  name: example
  namespace: foo
spec:
  rules:
    - host: www.example.com
      http:
        paths:
          - backend:
              serviceName: exampleService
              servicePort: 80
            path: /
  # This section is only required if TLS is to be enabled for the Ingress
  tls:
      - hosts:
          - www.example.com
        secretName: example-tls
```

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

### Install OptScale REST API Client (Editable) (Python)

Source: https://github.com/hystax/optscale/blob/integration/docker_images/booking_observer/requirements.txt

Specifies installing the OptScale REST API client package in editable mode from a local path.

```Python
-e optscale_client/rest_api_client
```

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

### Install Nginx Ingress with Stats and Metrics Enabled (Helm Console)

Source: https://github.com/hystax/optscale/blob/integration/optscale-deploy/ansible/roles/k8s-configure/files/nginx-ingress/README.md

Installs the stable/nginx-ingress Helm chart named 'my-release' and enables both the controller's statistics and Prometheus metrics endpoints.

```console
$ helm install stable/nginx-ingress --name my-release \
    --set controller.stats.enabled=true \
    --set controller.metrics.enabled=true
```

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

### Running Ansible Playbook for K8s Master

Source: https://github.com/hystax/optscale/blob/integration/README.md

Command to execute an Ansible playbook (`ansible/k8s-master.yaml`) to configure a Kubernetes master node. It specifies the SSH user, prompts for SSH and become passwords, and targets a specific IP address.

```bash
ansible-playbook -e "ansible_ssh_user=<user>" -k -K -i "<ip address>," ansible/k8s-master.yaml
```

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

### Install Config Client in Editable Mode - requirements.txt

Source: https://github.com/hystax/optscale/blob/integration/docker_images/resource_violations/requirements.txt

Installs the OptScale configuration client package directly from its source directory in editable mode, useful for development.

```requirements.txt
-e optscale_client/config_client
```

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

### Install Config Client Locally - Python

Source: https://github.com/hystax/optscale/blob/integration/docker_images/run_observer/requirements.txt

Installs the local 'optscale_client/config_client' package in editable mode ('-e'), allowing development changes to be reflected without reinstallation.

```Python
-e optscale_client/config_client
```

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

### Checking Ingress Controller Pod Status

Source: https://github.com/hystax/optscale/blob/integration/README.md

Command using `kubectl` to list all pods in the current Kubernetes cluster and filter the output to show only lines containing "ingress", typically used to check the status of ingress controller pods.

```bash
kubectl get pod | grep ingress
```

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

### Install OptScale Time Tool Locally - Python

Source: https://github.com/hystax/optscale/blob/integration/docker_images/run_observer/requirements.txt

Installs the local 'tools/optscale_time' package in editable mode ('-e'), useful for development on this specific tool.

```Python
-e tools/optscale_time
```

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

### Generate Override for Indirect Vulnerabilities - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Runs the audit fix command to generate an override entry in package.json for vulnerabilities found in indirect dependencies. Review the generated override before applying.

```Shell
pnpm audit --fix
```

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

### Generate Jira App Descriptor URL (Template)

Source: https://github.com/hystax/optscale/blob/integration/jira_ui/README.md

Provides the template URL structure for calling the OptScale API endpoint responsible for generating the 'atlassian-connect.json' app descriptor file. Placeholders for your OptScale host and ngrok host need to be replaced.

```HTTP
https://<YOUR_OPTSCALE_HOST>/jira_bus/v2/app_descriptor?base_host=<YOUR_NGROK_HOST>
```

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

### Editable Install: OptScale Slacker Client (Python)

Source: https://github.com/hystax/optscale/blob/integration/slacker/test-requirements.txt

Specifies an editable installation ('-e') of the local 'optscale_client/slacker_client' package, allowing changes in the source directory to be reflected without reinstallation.

```Python
-e optscale_client/slacker_client
```

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

### Example API Pagination Response (JSON)

Source: https://github.com/hystax/optscale/blob/integration/documentation/api_pagination.md

This JSON snippet illustrates the structure of an API response that includes pagination details. It shows the limit, offset, and total_count parameters alongside the actual data (objects).

```JSON
{
    "limit": 10,
    "offset": 20,
    "total_count": 50,
    "objects": {...}
}
```

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

### Fix Direct npm Vulnerabilities - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Attempts to automatically fix vulnerabilities found in direct project dependencies where possible. This command may update package versions.

```Shell
pnpm audit --fix
```

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

### Example TLS Secret Resource (YAML)

Source: https://github.com/hystax/optscale/blob/integration/optscale-deploy/ansible/roles/k8s-configure/files/nginx-ingress/templates/NOTES.txt

An example Kubernetes Secret resource definition of type kubernetes.io/tls, used to store the base64 encoded certificate and key required for TLS termination on an Ingress resource.

```YAML
apiVersion: v1
kind: Secret
metadata:
  name: example-tls
  namespace: foo
data:
  tls.crt: <base64 encoded cert>
  tls.key: <base64 encoded key>
  type: kubernetes.io/tls
```

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

### Update GraphQL Schema Types - pnpm Shell

Source: https://github.com/hystax/optscale/blob/integration/ngui/README.md

Generates or updates the TypeScript types based on the GraphQL schema definition. Run this command whenever the GraphQL schema changes.

```Shell
pnpm codegen
```

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

### Change Directory to UI

Source: https://github.com/hystax/optscale/blob/integration/jira_ui/README.md

Navigates into the 'ui' directory where the frontend code for the Jira integration resides. This is a necessary step before executing npm commands specific to the UI.

```Shell
cd ui
```

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

### Specify Editable Install for Config Client (Python)

Source: https://github.com/hystax/optscale/blob/integration/docker_images/layout_cleaner/requirements.txt

Specifies an editable installation for the `optscale_client/config_client` package, typically used in development environments to link directly to the source code directory. This allows changes to the source code to be reflected without re-installing the package.

```Python
-e optscale_client/config_client
```

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

### Listing OptScale Client Packages for Editable Install (Python)

Source: https://github.com/hystax/optscale/blob/integration/docker_images/demo_org_cleanup/requirements.txt

Specifies OptScale client packages (`config_client` and `rest_api_client`) to be installed in editable mode. This is typically used in development environments to allow changes to the package source code to be reflected without reinstallation.

```Python
-e optscale_client/config_client
-e optscale_client/rest_api_client
```

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

### Install REST API Client in Editable Mode - requirements.txt

Source: https://github.com/hystax/optscale/blob/integration/docker_images/resource_violations/requirements.txt

Installs the OptScale REST API client package directly from its source directory in editable mode, facilitating local development and testing.

```requirements.txt
-e optscale_client/rest_api_client
```

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

### Install Nginx Ingress with Stats Enabled (Helm Console)

Source: https://github.com/hystax/optscale/blob/integration/optscale-deploy/ansible/roles/k8s-configure/files/nginx-ingress/README.md

Installs the stable/nginx-ingress Helm chart named 'my-release' and enables the controller's statistics endpoint by setting `controller.stats.enabled` to true.

```console
$ helm install stable/nginx-ingress --name my-release \
    --set controller.stats.enabled=true
```

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

### Install Dependencies for send_templates.py (Bash)

Source: https://github.com/hystax/optscale/blob/integration/herald/modules/email_generator/CUSTOM_EMAIL_README.md

Installs the required Python packages `requests` and `urllib3` using pip, which are necessary for the `send_templates.py` script to function.

```Bash
pip install requests urllib3
```

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

### Specify Editable Python Installations

Source: https://github.com/hystax/optscale/blob/integration/herald/test-requirements.txt

This snippet specifies packages that should be installed in editable mode, typically pointing to local source code directories within the project or linked repositories.

```Python
-e optscale_client/herald_client
-e tools/check_alembic_down_revisions
```

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

### Install Nginx Ingress with Increased Log Level (Helm Console)

Source: https://github.com/hystax/optscale/blob/integration/optscale-deploy/ansible/roles/k8s-configure/files/nginx-ingress/README.md

Installs the stable/nginx-ingress Helm chart and increases the controller's log verbosity to level 2 by setting the `controller.extraArgs.v` parameter.

```console
$ helm install stable/nginx-ingress --set controller.extraArgs.v=2
```

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

### Install Config Client in Editable Mode - Requirements

Source: https://github.com/hystax/optscale/blob/integration/docker_images/resource_observer/requirements.txt

Installs the optscale_client/config_client package in editable mode ('-e'), linking the package directly to the source code directory. This is typically used during local development to allow changes to the source code to be reflected without reinstallation.

```Requirements
-e optscale_client/config_client
```

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

### Use send_templates.py Script Example (Bash)

Source: https://github.com/hystax/optscale/blob/integration/herald/modules/email_generator/CUSTOM_EMAIL_README.md

Example command demonstrating how to execute the `send_templates.py` script with required arguments: target email addresses, OptScale cluster host IP, cluster secret, and optional template names.

```Bash
python3 send_templates.py -e user1@example.com user2@example.com --host 172.22.2.2 -s 7bab161d-2d6b-4af8-b43f-317502e55081 -t alert invite
```

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

### Install Python Dependencies (Shell)

Source: https://github.com/hystax/optscale/blob/integration/documentation/update_to_24.04.md

Installs the required Python packages listed in the requirements.txt file into the active virtual environment using pip.

```Shell
pip install -r requirements.txt
```

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

### Start Updated Cluster (Shell)

Source: https://github.com/hystax/optscale/blob/integration/documentation/update_to_24.04.md

Starts the updated Optscale cluster using the runkube.py script. Uses a saved overlay file, prevents pulling new images (--no-pull), includes ELK stack (--with-elk), and requires the release name and version.

```Shell
./runkube.py --no-pull --with-elk  -o overlay/user_template.yml -- <release_name> <version>
```

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

### Install Prerequisites (Shell)

Source: https://github.com/hystax/optscale/blob/integration/documentation/update_to_24.04.md

Updates the package list and installs essential packages required for the Optscale deployment, including Python 3, pip, sshpass, git, and virtualenv.

```Shell
sudo apt update; sudo apt install python3-pip sshpass git python3-virtualenv python3
```

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

### Install Local OptScale Clients - Python

Source: https://github.com/hystax/optscale/blob/integration/docker_images/bi_scheduler/requirements.txt

Specifies local OptScale client packages for editable installation using the '-e' flag, typically used during development to link directly to local source code directories.

```Python Dependencies
-e optscale_client/config_client
-e optscale_client/rest_api_client
```

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

### Editable Local Package Installations

Source: https://github.com/hystax/optscale/blob/integration/docker_images/webhook_executor/requirements.txt

Specifies local OptScale packages to be installed in editable mode, typically for development.

```Python
-e optscale_client/config_client
-e optscale_client/rest_api_client
-e tools/optscale_time
```

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

### Install Local OptScale Packages - Python Requirements

Source: https://github.com/hystax/optscale/blob/integration/docker_images/slacker_executor/requirements.txt

Specifies local OptScale client and tool packages to be installed in editable mode (-e), useful for development.

```Python Requirements
-e optscale_client/auth_client
-e optscale_client/config_client
-e optscale_client/rest_api_client
-e optscale_client/slacker_client
-e tools/optscale_time
```

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

### Install Local OptScale Clients (Python Requirements)

Source: https://github.com/hystax/optscale/blob/integration/docker_images/calendar_observer/requirements.txt

Specifies that the `config_client` and `rest_api_client` packages from the local `optscale_client` directory should be installed in editable mode (`-e`). This is typically used during development to allow changes without reinstallation.

```Python Requirements
-e optscale_client/config_client
-e optscale_client/rest_api_client
```

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

### Project Dependencies List - Python

Source: https://github.com/hystax/optscale/blob/integration/insider/insider_api/requirements.txt

This snippet specifies the Python packages and their exact versions required for the project to run. It includes standard packages installed via pip and local paths for OptScale-specific components installed in editable mode.

```Python
tornado==6.4.2
pymongo==4.6.3
apispec==6.3.1
pyyaml==6.0.1
# OptScale packages
-e optscale_client/config_client
-e optscale_client/rest_api_client
-e tools/cloud_adapter
-e tools/optscale_exceptions
-e tools/optscale_time
```

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

### Editable Install: Alembic Check Tool (Python)

Source: https://github.com/hystax/optscale/blob/integration/slacker/test-requirements.txt

Specifies an editable installation ('-e') of a local tool located at 'tools/check_alembic_down_revisions', likely related to checking Alembic database migration scripts.

```Python
-e tools/check_alembic_down_revisions
```

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

### Install REST API Client in Editable Mode - Requirements

Source: https://github.com/hystax/optscale/blob/integration/docker_images/resource_observer/requirements.txt

Installs the optscale_client/rest_api_client package in editable mode ('-e'), linking the package directly to the source code directory. This is typically used during local development to allow changes to the source code to be reflected without reinstallation.

```Requirements
-e optscale_client/rest_api_client
```

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

### Delete Specific Optscale Deployment Example (Shell)

Source: https://github.com/hystax/optscale/blob/integration/documentation/update_to_24.04.md

An example of executing the runkube.py script to delete a specific Optscale release named 'os-1'. This follows the general deletion command.

```Shell
./runkube.py -d  -- os-1 local
```

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

### Listing Python Dependencies

Source: https://github.com/hystax/optscale/blob/integration/metroculus/metroculus_api/requirements.txt

Specifies the required Python packages and their versions, including local editable installations for OptScale components.

```Python
tornado==6.4.2
apispec==6.3.1
pymongo==4.6.3
clickhouse-connect==0.8.15
pyyaml==6.0.1
# OptScale packages
-e optscale_client/config_client
-e tools/cloud_adapter
-e tools/optscale_exceptions
```

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

### Install Update Manager Core (Shell)

Source: https://github.com/hystax/optscale/blob/integration/documentation/update_to_24.04.md

Installs the core package required for performing Ubuntu release upgrades using the do-release-upgrade command.

```Shell
sudo apt install update-manager-core
```

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

### Install OptScale REST API Client in Editable Mode - Python

Source: https://github.com/hystax/optscale/blob/integration/trapper/trapper_scheduler/requirements.txt

Similar to the config client, this line installs the 'optscale_client/rest_api_client' package in editable mode ('-e'), linking it directly to the local source directory for development.

```Python
-e optscale_client/rest_api_client
```

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

### Project Dependencies - Python requirements

Source: https://github.com/hystax/optscale/blob/integration/docker_images/live_demo_generator/requirements.txt

This snippet specifies the required Python packages and local editable installations for the project. It includes external libraries like kombu and pymongo, as well as references to local OptScale packages installed in editable mode.

```Python requirements
kombu==5.3.4
pymongo==4.6.3

# OptScale packages
-e optscale_client/config_client
-e optscale_client/rest_api_client
-e tools/optscale_time
```

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

### Project Dependencies - Python

Source: https://github.com/hystax/optscale/blob/integration/insider/insider_worker/requirements.txt

Specifies the core Python libraries and local packages required for the project to run, using the standard requirements.txt format. Includes version pinning for stability and editable installs for local development.

```Python
kombu==5.3.4
requests==2.32.3
pymongo==4.6.3
# OptScale packages
-e optscale_client/config_client
-e optscale_client/rest_api_client
```

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

### Install OptScale Config Client in Editable Mode - Python

Source: https://github.com/hystax/optscale/blob/integration/trapper/trapper_scheduler/requirements.txt

This line instructs the package manager to install the 'optscale_client/config_client' package in editable mode ('-e'). This is typically used during development to link directly to the source code.

```Python
-e optscale_client/config_client
```

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

### Local OptScale Package Dependencies

Source: https://github.com/hystax/optscale/blob/integration/bulldozer/bulldozer_worker/requirements.txt

Includes local OptScale client and tool packages using editable installs (-e) for development purposes.

```requirements.txt
# OptScale packages
-e optscale_client/arcee_client
-e optscale_client/config_client
-e optscale_client/rest_api_client
-e optscale_client/bulldozer_client
-e tools/optscale_time
```

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

### Defining Python Dependencies

Source: https://github.com/hystax/optscale/blob/integration/katara/katara_worker/test-requirements.txt

This snippet lists the specific versions of Python packages required for the project to ensure consistent environments across different setups.

```Python
coverage==4.2
pycodestyle==2.11.1
pylint==3.0.2
freezegun==0.3.8
concurrencytest==0.1.2
```

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

### Python Package Dependencies

Source: https://github.com/hystax/optscale/blob/integration/metroculus/test-requirements.txt

Specifies the required Python packages with version constraints and includes a local editable installation of an OptScale client package.

```Python
coverage==4.2
pycodestyle==2.11.1
pylint==3.0.2
concurrencytest==0.1.2
# OptScale packages
-e optscale_client/metroculus_client
```

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

### Setup remote page for iframe embedding (HTML/JS/CSS)

Source: https://github.com/hystax/optscale/blob/integration/ngui/ui/src/components/FullHeightIframe/iframe setup.md

Provides the necessary HTML, JavaScript, and CSS code for a page intended to be loaded inside an iframe. The script checks if the page is iframed, redirects if not, posts the page height to the parent window via postMessage, and hides a specific cookie notice element. It requires a browser environment and a parent window capable of receiving messages.

```HTML
<script>
    (function () {
        const htmlTag = document.getElementsByTagName("html")[0]; 
        const editor = document.getElementsByTagName("BODY")[0].className.lastIndexOf("elementor-editor") != -1;

        const isIframed = () => {
            try {
                return window.self !== window.top;
            } catch (e) {
                return true;
            }
        }

        if (!isIframed() && !editor) {
            window.location.href = "/"
        }

        const postHeightMessage = () => {
            const height = htmlTag.getBoundingClientRect().height;
            window.parent.postMessage({ iframeHeight: height }, "*");
        }

        window.addEventListener('load', (event) => {
            // adding "iframed" class to fix strange +1px scroll
            if (isIframed) {
                htmlTag.className += " iframed";
            }

            postHeightMessage();

            window.addEventListener('resize', postHeightMessage);
        });

    }());
</script>

<style>
    #cookie-notice {
        display: none !important;
    }

    html.iframed {
        overflow: hidden;
    }
</style>
```

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

### Listing Python Dependencies

Source: https://github.com/hystax/optscale/blob/integration/herald/requirements.txt

This snippet lists the required external Python packages with their specific versions and references local OptScale packages using editable installs.

```requirements.txt
SQLAlchemy==1.3.24
tornado==6.4.2
requests==2.32.3
netaddr==0.8.0
alembic==1.13.1
pika==1.1.0
mysql-connector-python==9.1.0
pystache==0.6.0
boto3==1.34.7

# OptScale packages
-e optscale_client/config_client
-e optscale_client/auth_client
-e tools/optscale_exceptions
```

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

### Port-Forward for ClusterIP Access (Shell)

Source: https://github.com/hystax/optscale/blob/integration/optscale-deploy/ansible/roles/k8s-configure/files/nginx-ingress/templates/NOTES.txt

Commands to find the controller pod name and set up a local port-forward to access the application via localhost when the controller service type is ClusterIP.

```Shell
  export POD_NAME=$(kubectl --namespace {{ .Release.Namespace }} get pods -o jsonpath="{.items[0].metadata.name}" -l "app={{ template "nginx-ingress.name" . }},component={{ .Values.controller.name }},release={{ .Release.Name }}")
  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:80
  echo "Visit http://127.0.0.1:8080 to access your application."
```

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

### Specify Local OptScale Dependencies (Python)

Source: https://github.com/hystax/optscale/blob/integration/docker_images/power_schedule/requirements.txt

Specifies local editable installations of core OptScale client and tool packages using the -e flag.

```Python
-e optscale_client/config_client
-e optscale_client/rest_api_client
-e tools/cloud_adapter
```

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

### Listing Python Dependencies

Source: https://github.com/hystax/optscale/blob/integration/katara/katara_worker/requirements.txt

This snippet lists the required Python packages for the project. It includes external libraries with specific version constraints and local OptScale components installed in editable mode (`-e`).

```Python
kombu==5.3.4
boto3==1.34.7
currency-symbols==2.0.3
# OptScale packages
-e optscale_client/config_client
-e optscale_client/rest_api_client
-e optscale_client/auth_client
-e optscale_client/katara_client
-e tools/optscale_time
```

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

### Restarting OptScale Cluster with Updated Configuration

Source: https://github.com/hystax/optscale/blob/integration/documentation/setting_up_smtp.md

Command to restart the OptScale cluster using the `runkube.py` script, applying the updated configuration from the specified `user_template.yml` file. The `--with-elk` flag indicates that the ELK stack should also be included in the restart.

```Shell
./runkube.py --with-elk  -o overlay/user_template.yml -- <deployment name> <version>
```

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

### Install Local OptScale Packages - Python Requirements

Source: https://github.com/hystax/optscale/blob/integration/docker_images/organization_violations/requirements.txt

Installs local OptScale client and tool packages in editable mode (-e), which is useful for development as changes in the source code are immediately reflected without reinstallation.

```Python Requirements
-e optscale_client/config_client
-e optscale_client/rest_api_client
-e tools/optscale_time
```

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

### Pinned Python Dependencies

Source: https://github.com/hystax/optscale/blob/integration/jira_bus/test-requirements.txt

Lists specific versions of Python packages required for the project, ensuring consistent environments across different setups. These packages are typically installed via pip.

```Python
pep8==1.7.1
coverage==4.2
pycodestyle==2.11.1
pylint==3.0.2
freezegun==0.3.8
```

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

### Listing Python Dependencies

Source: https://github.com/hystax/optscale/blob/integration/optscale-deploy/requirements.txt

This snippet lists the Python packages and their exact versions required for the project. This format is commonly used in a requirements.txt file to ensure consistent environments across installations.

```Python Dependencies
ansible==9.0.1
pyyaml==6.0.1
kubernetes==10.0.1
python-on-whales==0.72.0
```

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

### Listing Python Dependencies

Source: https://github.com/hystax/optscale/blob/integration/bi_exporter/bumblebi/exporter/requirements.txt

This snippet lists the external Python packages with their specific versions and includes local OptScale packages installed in editable mode.

```Python
kombu==5.3.4
boto3==1.34.7
clickhouse-connect==0.8.15
pymongo==4.6.3

# OptScale packages
-e optscale_client/config_client
-e optscale_client/rest_api_client
```

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

### Local OptScale Package Dependencies

Source: https://github.com/hystax/optscale/blob/integration/docker_images/users_dataset_generator/requirements.txt

Specifies local OptScale components installed in editable mode for development or testing.

```Python
-e optscale_client/config_client
-e tools/optscale_data
```

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

### Specify Local OptScale Client Dependency - Requirements File

Source: https://github.com/hystax/optscale/blob/integration/insider/insider_scheduler/requirements.txt

Specifies a local dependency on the 'optscale_client/config_client' package, installed in editable mode ('-e').

```Requirements File
-e optscale_client/config_client
```

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

### Include Local OptScale Packages

Source: https://github.com/hystax/optscale/blob/integration/katara/katara_service/requirements.txt

Includes local OptScale packages in editable mode (-e), linking them directly from their source directories for development or local installation.

```Python
-e optscale_client/config_client
-e optscale_client/rest_api_client
-e optscale_client/auth_client
-e tools/optscale_exceptions
-e tools/optscale_time
```

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

### Specify Local OptScale Dependencies - Python

Source: https://github.com/hystax/optscale/blob/integration/docker_images/keeper_executor/requirements.txt

Specifies local paths for editable installation of various OptScale client packages, facilitating development and testing.

```Python
-e optscale_client/config_client
-e optscale_client/rest_api_client
-e optscale_client/report_client
-e optscale_client/herald_client
-e optscale_client/auth_client
```

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

### Python Project Dependencies List

Source: https://github.com/hystax/optscale/blob/integration/risp/test-requirements.txt

Specifies the exact versions of Python packages required for the project to ensure consistent environments across different setups.

```Python
concurrencytest==0.1.2
pycodestyle==2.11.1
pylint==3.0.2
pyyaml==6.0.1
```

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

### Project Dependencies (requirements.txt)

Source: https://github.com/hystax/optscale/blob/integration/diworker/requirements.txt

This snippet lists the external Python packages with their versions and local OptScale tools installed in editable mode, defining the project's runtime environment.

```Python
pymongo==4.6.3
kombu==5.3.4
boto3==1.34.7
mongodb-migrations==0.7.0
retrying==1.3.3
pandas==2.1.4
pyarrow==14.0.1
clickhouse-connect==0.8.15
pyrabbit==1.1.0
# OptScale packages
-e tools/cloud_adapter
-e tools/optscale_data
-e tools/optscale_time
-e optscale_client/config_client
-e optscale_client/herald_client
-e optscale_client/insider_client
-e optscale_client/rest_api_client
```

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

### Change Directory to OptScale Deployment

Source: https://github.com/hystax/optscale/blob/integration/documentation/google_auth.md

Navigate to the local directory containing the OptScale deployment scripts and configuration files.

```Bash
cd ~/optscale/optscale-deploy/
```

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

### Watch LoadBalancer Status (Shell)

Source: https://github.com/hystax/optscale/blob/integration/optscale-deploy/ansible/roles/k8s-configure/files/nginx-ingress/templates/NOTES.txt

Command to watch the status of the LoadBalancer service to see when an external IP address is assigned, useful when the controller service type is LoadBalancer.

```Shell
kubectl --namespace {{ .Release.Namespace }} get services -o wide -w {{ template "nginx-ingress.controller.fullname" . }}
```

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

### List Helm Releases (Shell)

Source: https://github.com/hystax/optscale/blob/integration/documentation/update_to_24.04.md

Lists installed Helm releases and filters the output to find the Optscale release name. Useful if the release name is unknown.

```Shell
helm list | grep optscale
```

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

### Listing Python Dependencies

Source: https://github.com/hystax/optscale/blob/integration/auth/requirements.txt

This snippet lists the external and local Python package dependencies required for the project, specifying exact versions or version constraints for reproducibility. It includes standard libraries like SQLAlchemy, requests, and cryptography, as well as editable installations of local OptScale tools and clients.

```Python
SQLAlchemy==1.3.24
mysql-connector-python==9.1.0
tornado==6.4.2
alembic==1.13.1
pymacaroons==0.9.2
ordered-set==4.1.0
apispec==6.3.1
google-auth==1.23.0
requests==2.32.3
PyJWT>=2.4.0
cryptography==44.0.1
pyyaml==6.0.1
zcrmsdk==3.1.0
# OptScale packages
-e tools/optscale_exceptions
-e tools/optscale_time
-e optscale_client/config_client
-e optscale_client/rest_api_client
```

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

### Project Dependencies List

Source: https://github.com/hystax/optscale/blob/integration/docker_images/failed_imports_dataset_generator/requirements.txt

Specifies the exact versions of external Python libraries and includes local packages installed in editable mode.

```Requirements File
boto3==1.34.7
mysql-connector-python==9.1.0
SQLAlchemy==1.3.24

# OptScale packages
-e optscale_client/config_client
-e tools/optscale_time
```

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

### Project Dependencies - Python

Source: https://github.com/hystax/optscale/blob/integration/arcee/arcee_receiver/requirements.txt

Specifies the core Python libraries and their exact versions required for the project, along with local OptScale packages installed in editable mode.

```Python
aiohttp==3.10.11
sanic==23.12.1
sanic-ext==23.12.0
motor==3.6.0
kombu==5.3.4
pymongo==4.9.1
python-etcd==0.4.5
mongodb-migrations==1.2.1
pydantic==2.4.2
# OptScale packages
-e optscale_client/config_client
-e optscale_client/aconfig_cl
-e tools/optscale_time
```

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

### Check Ubuntu Version (Shell)

Source: https://github.com/hystax/optscale/blob/integration/documentation/update_to_24.04.md

Displays the Ubuntu distribution information, including the current version. Used to verify the starting version before a release upgrade.

```Shell
lsb_release -a
```

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

### Editable Local Dependencies

Source: https://github.com/hystax/optscale/blob/integration/auth/test-requirements.txt

Includes local packages installed in editable mode, typically used during development to link directly to source code.

```Python
-e optscale_client/auth_client
-e tools/check_alembic_down_revisions
```

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

### Internal OptScale Packages

Source: https://github.com/hystax/optscale/blob/integration/slacker/requirements.txt

Specifies local OptScale packages installed in editable mode using the -e flag, referencing their relative paths.

```Python
# OptScale packages
-e tools/optscale_exceptions
-e tools/optscale_time
-e optscale_client/auth_client
-e optscale_client/config_client
-e optscale_client/rest_api_client
```

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

### Python Project Dependencies

Source: https://github.com/hystax/optscale/blob/integration/keeper/test-requirements.txt

Specifies the Python packages required for the project, including versions for code style checking (pycodestyle), static analysis (pylint), test coverage (coverage), database mocking (mongomock), and a local editable installation of the optscale report client.

```Python
pycodestyle==2.11.1
pylint==3.0.2
coverage==4.2
mongomock==3.19.0

-e optscale_client/report_client
```

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

### Defining Python Project Dependencies

Source: https://github.com/hystax/optscale/blob/integration/bumiworker/requirements.txt

This snippet lists the required external Python packages and local project modules needed for the application to run. External packages are specified with version constraints, while local modules are included using editable installs.

```Python
pymongo==4.6.3
kombu==5.3.4
boto3==1.34.7
clickhouse-connect==0.8.15
# OptScale packages
-e tools/cloud_adapter
-e tools/optscale_data
-e tools/optscale_time
-e optscale_client/config_client
-e optscale_client/herald_client
-e optscale_client/insider_client
-e optscale_client/metroculus_client
-e optscale_client/rest_api_client
```

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

### Project Dependencies List

Source: https://github.com/hystax/optscale/blob/integration/bumischeduler/test-requirements.txt

This snippet shows the list of Python packages and their exact versions required for the project to run correctly. These dependencies are installed using a package manager like pip.

```text
coverage==4.2
pycodestyle==2.11.1
pylint==3.0.2
```

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

### Project Dependencies - Python

Source: https://github.com/hystax/optscale/blob/integration/bumiworker/test-requirements.txt

This snippet lists the required Python packages and their exact versions for the project. These dependencies are typically installed using pip from a requirements file.

```Python
coverage==4.2
pycodestyle==2.11.1
pylint==3.0.2
freezegun==0.3.8
mongomock==3.19.0
```

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

### Build New Components (Shell)

Source: https://github.com/hystax/optscale/blob/integration/documentation/update_to_24.04.md

Navigates up one directory and executes the build.sh script with the --use-nerdct flag to build Optscale components using nerdctl.

```Shell
cd .. && ./build.sh --use-nerdct
```

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

### Project Dependencies - Python

Source: https://github.com/hystax/optscale/blob/integration/gemini/gemini_worker/requirements.txt

Specifies the external and local Python package dependencies required for the project, including version constraints for external packages and editable installs for local packages.

```Python
kombu==5.3.4
boto3==1.34.7
clickhouse-connect==0.8.15
pymongo==4.6.3
# OptScale packages
-e optscale_client/config_client
-e optscale_client/rest_api_client
```

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

### List Project Dependencies (Python)

Source: https://github.com/hystax/optscale/blob/integration/metroculus/metroculus_worker/requirements.txt

This snippet lists the required Python packages with specific versions and includes local packages installed in editable mode (-e). These dependencies are necessary for the project to run correctly.

```Python
kombu==5.3.4
requests==2.32.3
clickhouse-connect==0.8.15
pymongo==4.6.3
# OptScale packages
-e optscale_client/config_client
-e optscale_client/rest_api_client
-e tools/cloud_adapter
-e tools/optscale_data
-e tools/optscale_time
```

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

### Updating OptScale Cluster Configuration - Shell

Source: https://github.com/hystax/optscale/blob/integration/documentation/verification_code.md

This command updates the OptScale cluster deployment using the `runkube.py` script. It applies the configuration from the specified overlay file (`overlay/user_template.yml`), which in this context is used to disable email verification. The `--with-elk` flag ensures the ELK stack is included in the update. Replace `<deployment name>` and `<version>` with your specific deployment details.

```Shell
./runkube.py --with-elk -o overlay/user_template.yml -- <deployment name> <version>
```

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

### Specify Kombu Dependency Version - Python

Source: https://github.com/hystax/optscale/blob/integration/trapper/trapper_scheduler/requirements.txt

This line specifies the exact version of the Kombu library required for the project. Using '==' ensures a specific, pinned version is installed.

```Python
kombu==5.3.4
```

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

### Configuring SMTP Settings in OptScale YAML

Source: https://github.com/hystax/optscale/blob/integration/documentation/setting_up_smtp.md

Provides the structure and fields required in the `overlay/user_template.yml` file to configure the SMTP server details, including server address, sender email, login, port, password, and protocol. These settings are necessary for OptScale to send email notifications.

```YAML
# SMTP server and credentials used for sending emails
smtp:
  server:
  email:
  login:
  port:
  password:
  protocol:
```

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

### Link Local Cloud Adapter Tool - Python

Source: https://github.com/hystax/optscale/blob/integration/docker_images/resource_discovery/requirements.txt

Links the local 'tools/cloud_adapter' directory as an editable package using the '-e' flag, integrating local tool code into the project environment.

```Python
-e tools/cloud_adapter
```

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

### Link Local Insider Client - Python

Source: https://github.com/hystax/optscale/blob/integration/docker_images/resource_discovery/requirements.txt

Links the local 'optscale_client/insider_client' directory as an editable package using the '-e' flag, facilitating development workflows.

```Python
-e optscale_client/insider_client
```

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

### Backup Docker Image

Source: https://github.com/hystax/optscale/blob/integration/documentation/howto_patch_pod.md

Creates a backup tag for the current local Docker image before patching.

```bash
docker tag <image_name>:local <image_name>:backup
```

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

### Link Local Config Client - Python

Source: https://github.com/hystax/optscale/blob/integration/docker_images/resource_discovery/requirements.txt

Links the local 'optscale_client/config_client' directory as an editable package using the '-e' flag, useful for development and testing local changes.

```Python
-e optscale_client/config_client
```

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

### Backup Nerdctl Image

Source: https://github.com/hystax/optscale/blob/integration/documentation/howto_patch_pod.md

Creates a backup tag for the current local Nerdctl image before patching.

```bash
nerdctl tag <image_name>:local <image_name>:backup
```

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

### Build Nerdctl Image from Source (build.sh)

Source: https://github.com/hystax/optscale/blob/integration/documentation/howto_patch_pod.md

Executes the build script to build a Nerdctl image for a specific service from source code, tagging it as 'local' by default and specifying the use of nerdctl.

```bash
./build.sh <service_name> --use-nerdctl
```

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

### Initializing Arcee Run and Linking to Task (Python)

Source: https://github.com/hystax/optscale/blob/integration/ngui/ui/public/docs/tasks-create.md

This snippet shows how to initialize an Arcee run and link it to a specific task using the unique task key. The `profiling_token` is also included as a parameter.

```Python
arcee.init()
```

```Python
arcee.init(profiling_token, task_key)
```

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

### Update OptScale Cluster with Google Maps Config

Source: https://github.com/hystax/optscale/blob/integration/documentation/enable_googlemaps.md

Executes the runkube.py script to update the OptScale cluster, applying the configuration changes from the specified overlay file (user_template.yml) and including ELK stack components.

```Shell
./runkube.py --with-elk -o overlay/user_template.yml -- <deployment name> <version>
```