diff --git a/.github/workflows/ansible-deploy.yml b/.github/workflows/ansible-deploy.yml new file mode 100644 index 0000000000..cc74d130ed --- /dev/null +++ b/.github/workflows/ansible-deploy.yml @@ -0,0 +1,90 @@ +name: Ansible Deployment + +on: + push: + branches: [ master, lab11 ] + + pull_request: + branches: [ master ] + paths: + - 'app_python/ansible/**' + +jobs: + + lint: + name: Ansible Lint + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: '3.12' + + - name: Install dependencies + run: | + pip install ansible ansible-lint + + - name: Run ansible-lint + run: | + cd app_python/ansible + ansible-lint playbooks/*.yml + + + deploy: + name: Deploy Application + needs: lint + runs-on: ubuntu-latest + + steps: + + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: '3.12' + + - name: Install Ansible + run: | + pip install ansible + + - name: Setup SSH + run: | + mkdir -p ~/.ssh + echo Store the private key + echo "${{ secrets.SSH_PRIVATE_KEY }}" > ~/.ssh/devops-terraform-passwordless + chmod 600 ~/.ssh/devops-terraform-passwordless + echo check key validity + ssh-keygen -y -f ~/.ssh/devops-terraform-passwordless + echo Append vm ip to known hosts + ssh-keyscan "${{ secrets.VM_HOST }}" >> ~/.ssh/known_hosts + + - name: Recreate group_vars/all.yml + run: | + mkdir -p app_python/ansible/group_vars + echo "${{ secrets.ANSIBLE_GROUP_VARS_ALL }}" | base64 --decode > app_python/ansible/group_vars/all.yml + + - name: Run Ansible Playbook + run: | + ssh -i ~/.ssh/devops-terraform-passwordless ubuntu@${{ secrets.VM_HOST }} "echo connected" + + echo '${{ secrets.ANSIBLE_VAULT_PASSWORD }}' > /tmp/vault_pass + cd app_python/ansible + + ansible-playbook playbooks/deploy.yml \ + -i inventory/hosts.ini \ + --vault-password-file /tmp/vault_pass \ + --extra-vars @./group_vars/all.yml + + rm /tmp/vault_pass + + - name: Verify Deployment + run: | + sleep 10 + curl -f http://${{ secrets.VM_HOST }}:1999 || exit 1 + curl -f http://${{ secrets.VM_HOST }}:1999/health || exit 1 \ No newline at end of file diff --git a/.github/workflows/python-ci.yml b/.github/workflows/python-ci.yml new file mode 100644 index 0000000000..e9bb430f24 --- /dev/null +++ b/.github/workflows/python-ci.yml @@ -0,0 +1,69 @@ +name: My FLask App Testing + +on: [push, pull_request] +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: '3.12' + cache: 'pip' + cache-dependency-path: './app_python/requirements.txt' + - name: Install dependencies + run: | + pip install -r ./app_python/requirements.txt + pip install pytest flake8 + - name: Lint + run: flake8 ./app_python/app.py + - name: Test + run: pytest ./app_python/tests/ + docker: + needs: test + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Login to Docker Hub + uses: docker/login-action@v3 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_TOKEN }} + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + - name: Generate version + run: echo "VERSION=$(date +%Y.%m.%d)" >> $GITHUB_ENV + - name: Build and push + uses: docker/build-push-action@v5 + with: + context: ./app_python + push: true + platforms: linux/amd64,linux/arm64 + tags: | + ${{ secrets.DOCKER_USERNAME }}/my-app:latest + ${{ secrets.DOCKER_USERNAME }}/my-app:${{ env.VERSION }} + ${{ secrets.DOCKER_USERNAME }}/my-app:${{ github.sha }} + cache-from: type=gha + cache-to: type=gha,mode=max + security: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: '3.12' + cache: 'pip' + cache-dependency-path: './app_python/requirements.txt' + - name: Install dependencies + run: | + pip install -r app_python/requirements.txt + - name: Install Snyk CLI + run: npm install -g snyk + - name: Run Snyk + env: + SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }} + run: | + snyk test app_python \ + --severity-threshold=high diff --git a/.gitignore b/.gitignore index 30d74d2584..e0d7cccaf5 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,14 @@ -test \ No newline at end of file +# OS +.DS_Store + +# Vault +app_python/ansible/group_vars/all.yml + +# File for me +app_python/reminder.md + +.vscode/settings.json + +app_python/monitoring/.env + +argocd_pass \ No newline at end of file diff --git a/.wrangler/cache/wrangler-account.json b/.wrangler/cache/wrangler-account.json new file mode 100644 index 0000000000..16741862e0 --- /dev/null +++ b/.wrangler/cache/wrangler-account.json @@ -0,0 +1,6 @@ +{ + "account": { + "id": "7a19bada09a97582626ff1817cab49ed", + "name": "V.levasheva@innopolis.university's Account" + } +} \ No newline at end of file diff --git a/app_python/.dockerignore b/app_python/.dockerignore new file mode 100644 index 0000000000..889bdb36b4 --- /dev/null +++ b/app_python/.dockerignore @@ -0,0 +1,29 @@ +# Python +__pycache__/ +*.py[cod] +venv/ +*.log +.venv/ + +# Version control +.git +.gitignore + +# IDE +.vscode/ +.idea/ + +# OS +.DS_Store + +# Secrets +.env +*.pem +secrets/ + +# Documentation +*.md +docs/ + +# Tests +tests/ \ No newline at end of file diff --git a/app_python/.gitignore b/app_python/.gitignore new file mode 100644 index 0000000000..65b17f162c --- /dev/null +++ b/app_python/.gitignore @@ -0,0 +1,16 @@ +# Python +__pycache__/ +*.py[cod] +venv/ +*.log + +# IDE +.vscode/ +.idea/ + +# OS +.DS_Store + +# Vault +./ansible/group_vars/all.yml +~/.vault_pass.txt \ No newline at end of file diff --git a/app_python/.python-version b/app_python/.python-version new file mode 100644 index 0000000000..e18b651909 --- /dev/null +++ b/app_python/.python-version @@ -0,0 +1 @@ +devops diff --git a/app_python/Dockerfile b/app_python/Dockerfile new file mode 100644 index 0000000000..22740e5e88 --- /dev/null +++ b/app_python/Dockerfile @@ -0,0 +1,18 @@ +FROM python:3.13-slim AS builder +WORKDIR /app_python +COPY requirements.txt . +RUN pip install --upgrade pip && \ + pip install --no-cache-dir -r requirements.txt +COPY app.py . + +FROM python:3.13-slim +ENV PORT="12345" +EXPOSE 12345 +RUN apt update && apt install -y curl && rm -rf /var/lib/apt/lists/* +RUN useradd --create-home --shell /bin/bash newuser +WORKDIR /app +RUN mkdir -p /app/data && chown -R newuser:newuser /app +COPY --from=builder /usr/local/lib/python3.13/site-packages /usr/local/lib/python3.13/site-packages +COPY --from=builder ./app_python . +USER newuser +CMD ["python", "app.py"] \ No newline at end of file diff --git a/app_python/README.md b/app_python/README.md new file mode 100644 index 0000000000..14c94fc1da --- /dev/null +++ b/app_python/README.md @@ -0,0 +1,109 @@ +# User-facing documentation + +## Overview + +When acessed, this web service answers with information either about itself (path "/") or with its health status ("/health). The information includes fields with the details of the service, system, runtime, request and enpoints. + +## Prerequisites + +### Python version + +Pyenv is used for the virtual environment managing. To install it refer to [this website](https://akrabat.com/creating-virtual-environments-with-pyenv/) for instructions. + +Python version used: 3.12.9 + + +### Python libraries: +- jsonify imported from Flask library +- request imported from Flask library +- platform +- socket +- datetime imported from datetime +- os +- logging + +### Installation + +```bash +pyenv virtualenv 3.12.9 webapp +pyenv activate webapp +pip install -r requirements.txt + ``` +### Running the Application +```bash +python app.py +PORT=8080 python app.py # if you want to use a custom port (the default is 5000) +``` + +### API Endpoints ### +- `GET /` - Service and system information +- `GET /health` - Health check +- `GET /visits` - See the number of times root directory was accessed +- `GET /ready` - Check if the application is ready to take requests +- `GET /health` - Check if the application is dead and should be reloaded + +### Configuration ### + +| № | Var name | Description +| ---| ----- | --------------------| +| #1 | HOST | Name of the host (defaults to socket.hostname first if available) | +| #2 | PORT | Port for the application access | +| #3 | DEBUG | Debug status | + +### Docker container ### + +#### Building the image locally ### + +Use the command in format: +```bash +docker build -t your-docker-username/image-name:image-tag directory-with-dockerfile +``` +Example: +```bash +docker build -t fountainer/my-app:1.1.0 . +``` +#### Running a container ### + +Use the command in format: +```bash +docker run -p host-port:container-port image-name:tag +``` +Example: +```bash +docker run -p 12345:12345 fountainer/my-app:1.1.0 +``` +#### Pulling from Docker Hub ### + +```bash +docker image pull image-name:image-tag +``` + +Example: +```bash +docker image pull app:1.0.0 +``` + +### Testing ### + +#### Workflow Badge + +[![My FLask App Testing](https://github.com/ffountainer/DevOps-Core-Course/actions/workflows/python-ci.yml/badge.svg?branch=master)](https://github.com/ffountainer/DevOps-Core-Course/actions/workflows/python-ci.yml) + +#### Unit testing #### + +To test the ./ endpoint: + +```bash +pytest ./app_python/tests/test_home_endpoint.py +``` + +To test the ./health endpoint: + + +```bash +pytest ./app_python/tests/test_health_endpoint.py +``` + +## Ansible deployment + +[![Ansible Deployment](https://github.com/ffountainer/DevOps-Core-Course/actions/workflows/ansible-deploy.yml/badge.svg)](https://github.com/ffountainer/DevOps-Core-Course/actions/workflows/ansible-deploy.yml) \ No newline at end of file diff --git a/app_python/ansible/.vault_pass.txt b/app_python/ansible/.vault_pass.txt new file mode 100644 index 0000000000..d9d37937a0 --- /dev/null +++ b/app_python/ansible/.vault_pass.txt @@ -0,0 +1 @@ +1967 diff --git a/app_python/ansible/ansible.cfg b/app_python/ansible/ansible.cfg new file mode 100644 index 0000000000..18d1667515 --- /dev/null +++ b/app_python/ansible/ansible.cfg @@ -0,0 +1,12 @@ +[defaults] +inventory = inventory/hosts.ini +roles_path = roles +host_key_checking = False +remote_user = ubuntu +retry_files_enabled = False +vault_password_file = .vault_pass.txt + +[privilege_escalation] +become = True +become_method = sudo +become_user = root \ No newline at end of file diff --git a/app_python/ansible/docs/LAB05.md b/app_python/ansible/docs/LAB05.md new file mode 100644 index 0000000000..082dcec5d2 --- /dev/null +++ b/app_python/ansible/docs/LAB05.md @@ -0,0 +1 @@ +!!!!!! real LAB05.md documentation lies in the app_python/docs/LAB05.md, since all prev labs documentation files were there, and I wanted to remain consistent. Please check this file, it has everything required by the task \ No newline at end of file diff --git a/app_python/ansible/docs/LAB06.md b/app_python/ansible/docs/LAB06.md new file mode 100644 index 0000000000..72d34032cc --- /dev/null +++ b/app_python/ansible/docs/LAB06.md @@ -0,0 +1 @@ +!!!!!! real LAB06.md documentation lies in the app_python/docs/LAB06.md, since all prev labs documentation files were there, and I wanted to remain consistent. Please check this file, it has everything required by the task \ No newline at end of file diff --git a/app_python/ansible/inventory/hosts.ini b/app_python/ansible/inventory/hosts.ini new file mode 100644 index 0000000000..af7b76d3fc --- /dev/null +++ b/app_python/ansible/inventory/hosts.ini @@ -0,0 +1,7 @@ +[webservers] +terraform ansible_host=93.77.189.231 + +[webservers:vars] +ansible_user=ubuntu +ansible_python_interpreter=/usr/bin/python3 +ansible_ssh_private_key_file=~/.ssh/devops-terraform-passwordless \ No newline at end of file diff --git a/app_python/ansible/playbooks/deploy.yml b/app_python/ansible/playbooks/deploy.yml new file mode 100644 index 0000000000..95174b9e0e --- /dev/null +++ b/app_python/ansible/playbooks/deploy.yml @@ -0,0 +1,7 @@ +--- +- name: Deploy application + hosts: webservers + become: true + + roles: + - web_app diff --git a/app_python/ansible/playbooks/provision.yml b/app_python/ansible/playbooks/provision.yml new file mode 100644 index 0000000000..6334c412cc --- /dev/null +++ b/app_python/ansible/playbooks/provision.yml @@ -0,0 +1,12 @@ +--- +- name: Provision web servers + hosts: webservers + become: true + + roles: + - role: common + tags: + - common + - role: docker + tags: + - docker diff --git a/app_python/ansible/roles/common/defaults/main.yml b/app_python/ansible/roles/common/defaults/main.yml new file mode 100644 index 0000000000..ec12cf9268 --- /dev/null +++ b/app_python/ansible/roles/common/defaults/main.yml @@ -0,0 +1,12 @@ +--- +common_packages: + - vim + - git + - curl + - python3-pip + - htop + +common_timezone_name: "Europe/Moscow" + +common_users: + - ubuntu diff --git a/app_python/ansible/roles/common/tasks/main.yml b/app_python/ansible/roles/common/tasks/main.yml new file mode 100644 index 0000000000..72042655d6 --- /dev/null +++ b/app_python/ansible/roles/common/tasks/main.yml @@ -0,0 +1,47 @@ +--- +# the first block with package installation tasks +- name: Install dependencies + become: true + tags: + - packages + block: + - name: Update apt cache + ansible.builtin.apt: + update_cache: true + cache_valid_time: 3600 + - name: Install common_packages + ansible.builtin.apt: + name: "{{ common_packages }}" + state: present + rescue: + - name: Handle installation failure + ansible.builtin.apt: + update_cache: true + force_apt_get: true + always: + - name: Write log file + ansible.builtin.copy: + content: "Common role has finished" + dest: /tmp/common.log + mode: "0644" + # The second block with user creation +- name: Manage users + become: true + tags: + - users + block: + - name: Create common users + ansible.builtin.user: + name: "{{ item }}" + state: present + create_home: true + loop: "{{ common_users }}" + # the third block with timezone set up +- name: Ensure timezone is set + become: true + tags: + - timezone + block: + - name: Set timezome + community.general.timezone: + name: "{{ common_timezone_name }}" diff --git a/app_python/ansible/roles/docker/defaults/main.yml b/app_python/ansible/roles/docker/defaults/main.yml new file mode 100644 index 0000000000..5638745c1e --- /dev/null +++ b/app_python/ansible/roles/docker/defaults/main.yml @@ -0,0 +1,8 @@ +--- +docker_packages: + - docker-ce + - docker-ce-cli + - containerd.io +docker_user: "ubuntu" +docker_gpg_url: "https://download.docker.com/linux/ubuntu/gpg" +docker_repo: "deb [arch=amd64] https://download.docker.com/linux/ubuntu {{ ansible_distribution_release }} stable" diff --git a/app_python/ansible/roles/docker/handlers/main.yml b/app_python/ansible/roles/docker/handlers/main.yml new file mode 100644 index 0000000000..07aa0eb290 --- /dev/null +++ b/app_python/ansible/roles/docker/handlers/main.yml @@ -0,0 +1,5 @@ +--- +- name: Restart docker + ansible.builtin.service: + name: docker + state: restarted diff --git a/app_python/ansible/roles/docker/tasks/main.yml b/app_python/ansible/roles/docker/tasks/main.yml new file mode 100644 index 0000000000..58c0a6981d --- /dev/null +++ b/app_python/ansible/roles/docker/tasks/main.yml @@ -0,0 +1,66 @@ +--- +- name: Docker installation + tags: + - docker_install + become: true + # block with docker installation and set up + block: + - name: Install prerequisites + ansible.builtin.apt: + name: + - apt-transport-https + - ca-certificates + - curl + - gnupg + - lsb-release + state: present + update_cache: true + force_apt_get: true + - name: Add Docker GPG key + ansible.builtin.apt_key: + url: "{{ docker_gpg_url }}" + state: present + - name: Add Docker APT repository + ansible.builtin.apt_repository: + repo: "{{ docker_repo }}" + state: present + filename: docker + - name: Install Docker packages + ansible.builtin.apt: + name: "{{ docker_packages }}" + state: present + update_cache: true + force_apt_get: true + notify: Restart docker + - name: Install python3-docker for Ansible Docker modules + ansible.builtin.apt: + name: python3-docker + state: present + rescue: + - name: Wait before retry + ansible.builtin.pause: + seconds: 10 + - name: Retry apt update + ansible.builtin.apt: + update_cache: true + - name: Retry adding Docker GPG key + ansible.builtin.apt_key: + url: "{{ docker_gpg_url }}" + state: present + always: + - name: Ensure docker service is enabled + ansible.builtin.service: + name: docker + state: started + enabled: true +- name: Configure docker + tags: + - docker_config + become: true + # block with docker configuration + block: + - name: Add user to Docker group + ansible.builtin.user: + name: "{{ docker_user }}" + groups: docker + append: true diff --git a/app_python/ansible/roles/web_app/defaults/main.yml b/app_python/ansible/roles/web_app/defaults/main.yml new file mode 100644 index 0000000000..fd4cb65878 --- /dev/null +++ b/app_python/ansible/roles/web_app/defaults/main.yml @@ -0,0 +1,17 @@ +--- +web_app_container_port: "12345" +web_app_restart_policy: unless-stopped +web_app_compose_project_dir: "/opt/{{ app_name }}" +web_app_docker_image: "{{ dockerhub_username }}/{{ app_name }}" +web_app_docker_tag: latest + +web_app_env: + PORT: "{{ web_app_container_port }}" + +# Wipe Logic Control +web_app_wipe: false # Default: do not wipe + +# Usage documentation: +# Set to true to remove application completely +# Wipe only: ansible-playbook deploy.yml -e "web_app_wipe=true" --tags web_app_wipe +# Clean install: ansible-playbook deploy.yml -e "web_app_wipe=true" diff --git a/app_python/ansible/roles/web_app/handlers/main.yml b/app_python/ansible/roles/web_app/handlers/main.yml new file mode 100644 index 0000000000..ad70fe1fa6 --- /dev/null +++ b/app_python/ansible/roles/web_app/handlers/main.yml @@ -0,0 +1,6 @@ +--- +- name: Restart app container + community.docker.docker_container: + name: "{{ app_container_name }}" + state: started + restart: false diff --git a/app_python/ansible/roles/web_app/meta/main.yml b/app_python/ansible/roles/web_app/meta/main.yml new file mode 100644 index 0000000000..cb7d8e0460 --- /dev/null +++ b/app_python/ansible/roles/web_app/meta/main.yml @@ -0,0 +1,3 @@ +--- +dependencies: + - role: docker diff --git a/app_python/ansible/roles/web_app/tasks/main.yml b/app_python/ansible/roles/web_app/tasks/main.yml new file mode 100644 index 0000000000..1536ed6da0 --- /dev/null +++ b/app_python/ansible/roles/web_app/tasks/main.yml @@ -0,0 +1,44 @@ +--- +- name: Deploy application with Docker Compose + tags: + - app_deploy + - compose + # block for app deployment with docker compose and possible wipe logic + block: + - name: Include wipe tasks + ansible.builtin.include_tasks: wipe.yml + tags: + - web_app_wipe + + - name: Create application directory + ansible.builtin.file: + path: "{{ web_app_compose_project_dir }}" + state: directory + owner: root + group: root + mode: "0755" + + - name: Template docker-compose.yml + ansible.builtin.template: + src: docker-compose.yml.j2 + dest: "{{ web_app_compose_project_dir }}/docker-compose.yml" + mode: "0644" + + - name: Deploy with Docker Compose + community.docker.docker_compose_v2: + project_src: "{{ web_app_compose_project_dir }}" + pull: missing + state: present + recreate: auto + + rescue: + - name: Handle deployment failure + ansible.builtin.debug: + msg: "Docker Compose deployment failed. Check logs and network." + + always: + - name: Log deployment attempt + ansible.builtin.copy: + content: "Docker Compose deployment attempted on {{ ansible_date_time.iso8601 }}" + dest: "/tmp/{{ app_name }}-compose.log" + mode: "0644" diff --git a/app_python/ansible/roles/web_app/tasks/wipe.yml b/app_python/ansible/roles/web_app/tasks/wipe.yml new file mode 100644 index 0000000000..0db3164ba0 --- /dev/null +++ b/app_python/ansible/roles/web_app/tasks/wipe.yml @@ -0,0 +1,27 @@ +--- +- name: Wipe web application + when: web_app_wipe | bool + tags: + - web_app_wipe + block: + - name: Stop and remove containers + community.docker.docker_compose_v2: + project_src: "{{ web_app_compose_project_dir }}" + state: absent + ignore_errors: "{{ ansible_check_mode }}" + + - name: Remove docker-compose file + ansible.builtin.file: + path: "{{ web_app_compose_project_dir }}/docker-compose.yml" + state: absent + ignore_errors: "{{ ansible_check_mode }}" + + - name: Remove application directory + ansible.builtin.file: + path: "{{ web_app_compose_project_dir }}" + state: absent + ignore_errors: "{{ ansible_check_mode }}" + + - name: Log wipe completion + ansible.builtin.debug: + msg: "Application {{ app_name }} wiped successfully" diff --git a/app_python/ansible/roles/web_app/templates/docker-compose.yml.j2 b/app_python/ansible/roles/web_app/templates/docker-compose.yml.j2 new file mode 100644 index 0000000000..e373f7d510 --- /dev/null +++ b/app_python/ansible/roles/web_app/templates/docker-compose.yml.j2 @@ -0,0 +1,22 @@ +version: '{{ docker_compose_version }}' + +services: + {{ app_name }}: + image: {{ web_app_docker_image }}:{{ web_app_docker_tag }} + + ports: + - "{{ app_port }}:{{ app_internal_port }}" + + restart: unless-stopped + + environment: +{% for key, value in web_app_env.items() %} + {{ key }}: "{{ value }}" +{% endfor %} + + networks: + - {{ app_name }}_network + +networks: + {{ app_name }}_network: + driver: bridge \ No newline at end of file diff --git a/app_python/app.py b/app_python/app.py new file mode 100644 index 0000000000..b0f3ff3816 --- /dev/null +++ b/app_python/app.py @@ -0,0 +1,348 @@ +""" +DevOps Info Service +Lab 1. Veronika Levasheva +""" + +from flask import Flask, jsonify +from flask import request +import platform +from datetime import datetime +import socket +import os +import logging +from pythonjsonlogger.json import JsonFormatter +from prometheus_client import Counter, Histogram, Gauge, generate_latest +import time +from flask import g, Response +from threading import Lock + +app = Flask(__name__) # creating an instance of Flask + + +logger = logging.getLogger(__name__) + + +# Log important events: startup, HTTP requests, errors +# Include context: method, path, status code, client IP + +logHandler = logging.StreamHandler() +formatter = JsonFormatter( + "levelname, asctime, message", + style=",", + rename_fields=( + {"levelname": "LEVEL", "asctime": "TIMESTAMP", "message": "MESSAGE"} + ), +) + +logHandler.setFormatter(formatter) +logger.addHandler(logHandler) + +logger.setLevel(logging.DEBUG) + +# Prometheus metrics + +http_requests_total = Counter( + "http_requests_total", "Total HTTP requests", + ["method", "endpoint", "status_code"] +) + +http_request_duration_seconds = Histogram( + "http_request_duration_seconds", + "HTTP request duration", ["method", "endpoint"] +) + +http_requests_in_progress = Gauge( + "http_requests_in_progress", + "HTTP requests currently being processed" +) + +endpoint_calls = Counter("devops_info_endpoint_calls", + "Endpoint calls", ["endpoint"]) + +system_info_duration = Histogram( + "devops_info_system_collection_seconds", + "System info collection time" +) + +DATA_DIR = os.getenv("DATA_DIR", "/tmp/data") +VISITS_FILE = os.path.join(DATA_DIR, "visits") + +visits_lock = Lock() +visits_count = 0 + + +def load_visits(): + global visits_count + + os.makedirs(DATA_DIR, exist_ok=True) + + if not os.path.exists(VISITS_FILE): + visits_count = 0 + return + + try: + with open(VISITS_FILE, "r") as f: + visits_count = int(f.read().strip()) + except Exception: + visits_count = 0 + + +def increment_visits(): + global visits_count + + with visits_lock: + visits_count += 1 + with open(VISITS_FILE, "w") as f: + f.write(str(visits_count)) + + return visits_count + + +def get_visits(): + with visits_lock: + return visits_count + + +@app.before_request +def before_request(): + g.start_time = time.time() + http_requests_in_progress.inc() + + +@app.after_request +def after_request(response): + duration = time.time() - g.start_time + + endpoint = request.path + + if endpoint == "/metrics": + return response + + if endpoint.startswith("/user/"): + endpoint = "/user/{id}" + + http_requests_total.labels( + method=request.method, endpoint=endpoint, + status_code=response.status_code + ).inc() + + http_request_duration_seconds.labels( + method=request.method, endpoint=endpoint + ).observe(duration) + + http_requests_in_progress.dec() + + return response + + +# variable names +platform_name = platform.system() +architecture = platform.machine() +python_version = platform.python_version() +hostname = socket.gethostname() + +# env variables +ADDRESS = os.getenv("ADDRESS", "0.0.0.0") +PORT = int(os.getenv("PORT", 1999)) +DEBUG = os.getenv("DEBUG", "True").lower() == "true" + + +@app.route("/metrics") +def metrics(): + return Response(generate_latest(), mimetype="text/plain") + + +# decorator for / path +@app.route("/", methods=["GET"]) +def get_endpoint(): + start = time.time() + endpoint_calls.labels(endpoint="/").inc() + current_visits = increment_visits() + logger.info( + { + "MESSAGE": f"Request: {request.method} {request.path}", + }, + extra={ + "CLIENT_IP": request.remote_addr, + "STATUS_CODE": 200, + "METHOD": request.method, + "PATH": request.path, + }, + ) + response = jsonify({ + "message": message, + "visits": current_visits + }) + response.status_code = 200 + system_info_duration.observe(time.time() - start) + return response + + +@app.route("/visits", methods=["GET"]) +def visits(): + start = time.time() + endpoint_calls.labels(endpoint="/visits").inc() + + count = get_visits() + + response = jsonify({"visits": count}) + response.status_code = 200 + + system_info_duration.observe(time.time() - start) + return response + + +@app.route("/ready") +def ready(): + start = time.time() + endpoint_calls.labels(endpoint="/ready").inc() + logger.info( + { + "MESSAGE": f"Request: {request.method} {request.path}", + }, + extra={ + "CLIENT_IP": request.remote_addr, + "STATUS_CODE": 200, + "METHOD": request.method, + "PATH": request.path, + }, + ) + response = jsonify({ + "status": "ready", + "timestamp": datetime.now().isoformat() + }) + response.status_code = 200 + system_info_duration.observe(time.time() - start) + return response + + +# decorator for /health path +@app.route("/health") +def health(): + start = time.time() + endpoint_calls.labels(endpoint="/health").inc() + # extra: status code, client ip + logger.info( + { + "MESSAGE": f"Request: {request.method} {request.path}", + }, + extra={ + "CLIENT_IP": request.remote_addr, + "STATUS_CODE": 200, + "METHOD": request.method, + "PATH": request.path, + }, + ) + response = jsonify( + { + "status": "healthy", + "timestamp": datetime.now().isoformat(), + "uptime_seconds": get_uptime()["seconds"], + } + ) + response.status_code = 200 + system_info_duration.observe(time.time() - start) + return response + + +# error handling + + +@app.errorhandler(404) +def not_found(error): + logger.error( + {"MESSAGE": "Endpoint does not exist"}, + extra={ + "ERROR": "Not Found", + "STATUS_CODE": 404, + "CLIENT_IP": request.remote_addr, + "METHOD": request.method, + "PATH": request.path, + }, + ) + return ( + jsonify(({"error": "Not Found", + "MESSAGE": "Endpoint does not exist"})), + 404, + ) + + +@app.errorhandler(500) +def internal_error(error): + logger.error( + {"MESSAGE": "Internal Server Error"}, + extra={ + "ERROR": "Not Found", + "STATUS_CODE": 500, + "CLIENT_IP": request.remote_addr, + "METHOD": request.method, + "PATH": request.path, + }, + ) + return ( + jsonify( + { + "error": "Internal Server Error", + "MESSAGE": "An unexpected error occurred", + } + ), + 500, + ) + + +start_time = datetime.now() + + +def get_uptime(): + delta = datetime.now() - start_time + seconds = int(delta.total_seconds()) + hours = seconds // 3600 + minutes = (seconds % 3600) // 60 + return {"seconds": seconds, "human": f"{hours} hours, {minutes} minutes"} + + +# json message with system and environment info +message = { + "service": { + "name": "devops-info-service", + "version": "1.0.0", + "description": "DevOps course info service", + "framework": "Flask", + "debug status": DEBUG, + }, + "system": { + "hostname": hostname, + "platform": platform_name, + "platform_version": "Ubuntu 24.04", + "architecture": architecture, + "cpu_count": 8, + "python_version": python_version, + }, + "runtime": { + "uptime_seconds": get_uptime(), + "uptime_human": "1 hour, 0 minutes", + "current_time": "2026-01-07T14:30:00.000Z", + "timezone": "UTC", + }, + "request": { + "client_ip": "127.0.0.1", + "port": PORT, + "user_agent": "curl/7.81.0", + "method": "GET", + "path": "/", + }, + "endpoints": [ + {"path": "/", "method": "GET", "description": "Service information"}, + {"path": "/health", "method": "GET", "description": "Health check"}, + ], +} + +logger.info( + { + "MESSAGE": f"Application starting on port {PORT}...", + } +) + +load_visits() +if __name__ == "__main__": + app.run(host=ADDRESS, port=PORT, debug=DEBUG) diff --git a/app_python/data/visits b/app_python/data/visits new file mode 100644 index 0000000000..86ee83a4a2 --- /dev/null +++ b/app_python/data/visits @@ -0,0 +1 @@ +40 \ No newline at end of file diff --git a/app_python/docker-compose.yml b/app_python/docker-compose.yml new file mode 100644 index 0000000000..eb623d9169 --- /dev/null +++ b/app_python/docker-compose.yml @@ -0,0 +1,13 @@ +version: "3.9" + +services: + app: + build: . + ports: + - "1999:12345" + environment: + - PORT=12345 + - ADDRESS=0.0.0.0 + - DATA_DIR=/app/data + volumes: + - ./data:/app/data \ No newline at end of file diff --git a/app_python/docs/LAB01.md b/app_python/docs/LAB01.md new file mode 100644 index 0000000000..159dae34a3 --- /dev/null +++ b/app_python/docs/LAB01.md @@ -0,0 +1,134 @@ +# Documentation + +## Framework Selection + +I chose Flask because it is quite good for the small projects and easy enough for the beginners, as I didn't have an experience with API before. It also has a lot of community support since it was released long ago. + +| Framework | Features | +|---------|------------| +| Flask | Easy to learn, a lot of documentation | +| FastAPI | Harder to learn, more suitable for big projects (but from reddit comments people seem to like it a lot)| +| Django | Also too heavy for a small project | + +## Best Practices Applied + +- Informative comments + +```python +# decorator for / path +# decorator for /health path +# error handling +``` +- PEP8 standarts with auto linting from black formatter (example is app.py itself) + +- clear structure + +- error handling + +```python +@app.errorhandler(404) +def not_found(error): + return jsonify({"error": "Not Found", "message": "Endpoint does not exist"}), 404 + + +@app.errorhandler(500) +def internal_error(error): + return ( + jsonify( + { + "error": "Internal Server Error", + "message": "An unexpected error occurred", + } + ), + 500, + ) +``` + +- logging +```python +logging.basicConfig( + level=logging.DEBUG, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s" +) + +logger.info("Application starting...") + +logger.debug(f"Request: {request.method} {request.path}") # inside decorators +``` +- requirements.txt and .gitignore + +## API Documentation + +- The web app can be accesed by this link: http://127.0.0.1:5000 + +### Request/response examples + +- Request Examples: + - GET / HTTP/1.1 + - GET /health HTTP/1.1 +- Response examples + - json and 200 OK code + - {"error":"Not Found","message":"Endpoint does not exist"} 404 not found error + - {"error":"Internal Server Error","message":"An unexpected error occurred"} 500 internal server error + +### Testing commands + +- test urls + - http://127.0.0.1:5000 + - http://127.0.0.1:5000/health + - http://127.0.0.1:5000/unknown +- curl + - curl http://127.0.0.1:5000/unknown + - curl http://127.0.0.1:5000/health + - curl http://127.0.0.1:5000/ + +## Testing Evidence + +### Screenshots + +Screenshots can be found in app/python/docs/screenshots. + +### Terminal output + +#### Curl + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % curl http://127.0.0.1:5000/unknown +{"error":"Not Found","message":"Endpoint does not exist"} + +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % curl http://127.0.0.1:5000/health +{"status":"healthy","timestamp":"2026-01-28T22:32:13.607128","uptime_seconds":352} + +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % curl http://127.0.0.1:5000/ +{"message":{"endpoints":[{"description":"Service information","method":"GET","path":"/"},{"description":"Health check","method":"GET","path":"/health"}],"request":{"client_ip":"127.0.0.1","method":"GET","path":"/","port":5000,"user_agent":"curl/7.81.0"},"runtime":{"current_time":"2026-01-07T14:30:00.000Z","timezone":"UTC","uptime_human":"1 hour, 0 minutes","uptime_seconds":{"human":"0 hours, 0 minutes","seconds":0}},"service":{"debug status":true,"description":"DevOps course info service","framework":"Flask","name":"devops-info-service","version":"1.0.0"},"system":{"architecture":"arm64","cpu_count":8,"hostname":"Veronicas-MacBook-Air.local","platform":"Darwin","platform_version":"Ubuntu 24.04","python_version":"3.12.9"}}} +``` +#### App started + +```bash +devops) fountainer@Veronicas-MacBook-Air app_python % python app.py +2026-01-28 22:36:05,289 - __main__ - INFO - Application starting... + * Serving Flask app 'app' + * Debug mode: off +2026-01-28 22:36:05,299 - werkzeug - INFO - WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. + * Running on http://127.0.0.1:5000 +2026-01-28 22:36:05,299 - werkzeug - INFO - Press CTRL+C to quit +2026-01-28 22:36:09,089 - werkzeug - INFO - 127.0.0.1 - - [28/Jan/2026 22:36:09] "GET /unknown HTTP/1.1" 404 - +2026-01-28 22:36:12,152 - __main__ - DEBUG - Request: GET / +2026-01-28 22:36:12,153 - werkzeug - INFO - 127.0.0.1 - - [28/Jan/2026 22:36:12] "GET / HTTP/1.1" 200 - +2026-01-28 22:36:18,600 - __main__ - DEBUG - Request: GET /health +2026-01-28 22:36:18,607 - werkzeug - INFO - 127.0.0.1 - - [28/Jan/2026 22:36:18] "GET /health HTTP/1.1" 200 - +2026-01-28 22:36:20,246 - __main__ - DEBUG - Request: GET /health +2026-01-28 22:36:20,247 - werkzeug - INFO - 127.0.0.1 - - [28/Jan/2026 22:36:20] "GET /health HTTP/1.1" 200 - +``` + +## Challenges & Solutions + +- It was quite hard for me to understand the structure since I didn't work with Flask and API in general before. I got some info from stackoverflow, documentations, etc. + +- I have encountered a problem with a jsonify library since I thought it wasn't comming from Flask library. Terminal errors helped to understand it eventually. + +- It took some time to understand how methods from request library work. + +## GitHub Community + +- starring repositories support open-source development and small but promising projects +- following developers lead to the opportunities of communication, exchanging experience, and making connections in the field. diff --git a/app_python/docs/LAB02.md b/app_python/docs/LAB02.md new file mode 100644 index 0000000000..9ae3741628 --- /dev/null +++ b/app_python/docs/LAB02.md @@ -0,0 +1,84 @@ +# Documentation + +## Docker Best Practices Applied + +- COPY commands for copying requirements before copying application code. This is a good practice because this way if we change the application code we won't have to rebuild all dependencies. + +```bash +COPY requirements.txt . +COPY app.py . +``` +- Multi-stage image. Firstly we build an image, then we run commands. It helps to reduce the final image size since all build tools won't be included. Example is the whole Dockerfile. + +- Small base image (python:3.13-slim), this way image builds faster since we don't need to install a giant package. + +- Creating and setting a non-root user. This is good for security since running as root is vulnerable. + +```bash +RUN useradd --create-home --shell /bin/bash newuser +USER newuser +``` +- .dockerignore file. We explicitly exclude files that should not be leaked to the public image (for security). + +- COPY only those files that are really needed (application code and dependencies). + +```bash +COPY requirements.txt . +COPY app.py . +``` +- EXPOSE port for documentation purposes. + +```bash +EXPOSE 12345 +``` + +## Image Information & Decisions + +- I chose python:3.13-slim because it is really small compared to the full version and was released not so long ago (I thought about using a distroless image, but the last available version was 3.12). + +- Final image is 158MB, it is very light (compressed size in dockerhub is even smaller: 47.32 MB) + +- Layer structure: I use multi-stage Dockerfile, so I have two parts: for building and for running. In the build stage I copy all dependencies and then application code, in the run-time stage I set an environment variable for the port, document it, add a new user and create a directory, then copy files with dependencies and application code, and then run commands. This way the time for building is utilised in an effective manner due to the small image, copy commands order, and multi-stage dockerfile. + +## Build & Run Process + +![Build](./screenshots/lab02-shots/build.png) + +![Running](./screenshots/lab02-shots/run.png) + +![Testing](./screenshots/lab02-shots/test.png) + +![Push](./screenshots/lab02-shots/push.png) + +![Pull](./screenshots/lab02-shots/pull.png) + +[Link to the image](https://hub.docker.com/repository/docker/fountainer/my-app/general) + +## Technical Analysis + +### Why does your Dockerfile work the way it does? + +Because Dockerfile provides a clear structure that can be easily followed and suited for your particular needs. It works the way it does because it replicates how the script is running on the host machine. + +### What would happen if you changed the layer order? + +If I change the COPY commands order after I make changes in application code all dependencies will be rebuilt too. If I remove the multi-stage the size of the image will increase. + +### What security considerations did you implement? + +Non-root user, .dockerignore, copying specific files. + +### How does .dockerignore improve your build? + +It excludes the possibility to copy files that contain private information (but we still can forget to add some files so it is better to only copy what we actually need). + +### Challenges & Solutions + +- I faced a problem with port mapping but docker documentation helped. Now I know how to set up the communication between host and container. While I was struggling I tried to debug what processes blocked the 5000 port (and it seemed to be docker itself). + + + + + + + diff --git a/app_python/docs/LAB03.md b/app_python/docs/LAB03.md new file mode 100644 index 0000000000..0585052aa9 --- /dev/null +++ b/app_python/docs/LAB03.md @@ -0,0 +1,97 @@ +# Documentation + +## Overview + +### Choose a Testing Framework + +Since the project is quite simple, it is not a big difference between frameworks regarding their more complex features. I chose pytest because it is easy to use as a beginner and it provides all needed functionality. + +### Test coverage & trigger configuration + +- I check the structure of a json response for ./ and ./health requests, and additionally review error cases (response.status code is 404 or 500). Also, I test the type of the value for importand fields. + +- The pipeline is triggered on push and pull requests. It is useful for me since I can check the pipeline during working on the lab (pushes) and then on pull request for the submission. + +### Versioning Strategy + +- latest tag + +- I chose to use Calendar Versioning since it is quite indicative for the university course (I can easily determine the image corresponding to the particular lab (by the date)). + +- Also I tag by commit SHA for needed image detection + +## Workflow Evidence + +### Tests terminal output + +![Passed tests](./screenshots/lab03-shots/unit%20test%20output.png) + +### Pipeline test with GitHub actions + +[Successful run](https://github.com/ffountainer/DevOps-Core-Course/actions/runs/21885090766) + +![](./screenshots/lab03-shots/pipeline%20success.png) + +### GitHub Image + +[Image](https://hub.docker.com/layers/fountainer/my-app/latest/images/sha256:ec4a12a2a6e91d464be4f1a908f23a3646ed05233d2ae82101357ea1e23bd677?uuid=8c4ce238-1b75-4c64-ba2e-b07167c9cb11%0A) + +## Best Practices Implemented + +- check on pull request to see the status before merging +- secrets for sensitive data +- docker image layer caching for quicker builds +- job dependencies (so docker build and push do not run if unit tests have not passed) +- add status badge to immediately see the current pipeline status +- dependency caching for quicker unit testing +- security scanning with Snyk for detecting vulnerabilities + +![Improvements](./screenshots/lab03-shots/improved%20perf.png) + +### Caching implementation and speed improvement metrics + +Caching is enabled by actions/setup-python@v5 and Docker layer caching, reducing dependency installation and image rebuild times. This decreased average workflow time from ~2-1 min to ~1-0.4 min (~40–60% faster on subsequent runs). + +![DockerHub images](./screenshots/lab03-shots/images%20with%20tags%20docker%20hub.png) + +### Snyk integration + +Initially there was a vulnerability with outdated flask version, so I upgraded it. + +## Key Decisions + +### Versioning Strategy + +- I chose to use Calendar Versioning since it is quite indicative for the university course (I can easily determine the image corresponding to the particular lab (by the date)). + +### Docker Tags + +- CI creates CalVer, latest, and SHA tags. + +### Workflow Triggers + +- The pipeline is triggered on push and pull requests. It is useful for me since I can check the pipeline during working on the lab (pushes) and then on pull request for the submission. + +### Test Coverage + +I check the structure of a json response for ./ and ./health requests, and additionally review error cases (response.status code is 404 or 500). Also, I test the type of the value for importand fields. + +What is not tested: + - if env variables provide correct values + +### Chosen actions + +- actions/checkout@v4: to check-out my repository under $GITHUB_WORKSPACE, so my workflow can access it + +- actions/setup-python@v5: to install python and add it to path and to allow caching + +- docker/login-action@v3: to login into docker + +- docker/setup-buildx-action@v3: to enable layer caching + +- docker/build-push-action@v5: to build and push image + +## Challenges + +- didn't work with unit testing and assert command before +- snyk didn't find my files so I stopped using snyk action and configured job manually \ No newline at end of file diff --git a/app_python/docs/LAB04.md b/app_python/docs/LAB04.md new file mode 100644 index 0000000000..ab38156561 --- /dev/null +++ b/app_python/docs/LAB04.md @@ -0,0 +1,198 @@ +# Documentation + +## Cloud provider and infrastructure + +### Cloud provider chosen and rationale + +- I chose Yandex Cloud since it provides solid resource provision with a lot of RAM and storage space, also it has a free trial period. + +### Instance type/size and why + +- 2 cpu cores and 2 gb of ram because the project is really small and we don't need a lot of resources for it. + +### Region/zone selected + +- zone ru-central1-a + +### Resources created (list all) + +- service account + +- boot disk with ubuntu image + +- vm (2 cores, 2 memory) + +- network + +- subnet (zone ru-central1-a) + +- security group + +## Task 1 (Terraform implementation) + +### Terraform version used + +Terraform v1.14.5 on darwin_arm64 + +### Project structure explanation + +``` +app_python/ +├── pulumi/ +│ ├── venv/ # Python virtual environment +│ ├── Pulumi.yaml # Pulumi project metadata +│ ├── Pulumi.dev.yaml # Stack config (gitignored) +│ ├── requirements.txt # Python dependencies +│ ├── __main__.py # Pulumi infrastructure code +| ├── .gitignore # Ignore state, credentials +│ └── README.md # Pulumi setup instructions +└── terraform/ + ├── .gitignore # Ignore state, credentials + ├── main.tf # Main resources + ├── variables.tf # Input variables + ├── outputs.tf # Output values + ├── terraform.tfvars # Variable values (gitignored) + └── README.md # Terraform setup instructions +``` + +### Key configuration decisions + +- connect with pair of SSH keys +- configure security group rules +- expose only necessary ports +- do not expose credentials + +### Challenges encountered + +Getting accustomed to the Yandex Cloud wasn't easy, and setting up SSH connection also was a little challanging. + +### Public IP address of created VM + +```bash +external_ip_address_vm = "62.84.117.91" +``` + +### SSH connection command + +```bash +ssh -i /home-directory/.ssh/terraform-vm-key ubuntu@62.84.117.91 +``` + +### Terminal output from terraform plan and terraform apply + +![Plan](./screenshots/lab04-shots/terraform%20plan.png) + +![Apply-1](./screenshots/lab04-shots/terraform%20apply-1.png) + +![Apply-2](./screenshots/lab04-shots/terraform%20apply-2.png) + +### Proof of SSH access to VM + +![SSH](./screenshots/lab04-shots/ssh%20output%20terraform.png) + +## Task 2 (Pulumi Implementation) + +### Pulumi version and language used + +- pulumi==3.222.0, python + +### Terraform destroy output + +![](./screenshots/lab04-shots/terraform%20destroy.png) + +### How code differs from Terraform + +- Palumi supports many programming language for configuration, while terraform only lets to use its default config language. + +### Advantages you discovered + +- It is easier to write in a familiar language in Palumi, but to be honest, I enjoyed writing terraform config more. + +### Challenges encountered + +- Had problems with SSH as well, also it wasn't so easy to find documentation and guides. + +### Terminal output + +- pulumi preview + +![](./screenshots/lab04-shots/pulumi%20preview.png) + +- pulumi up +![](./screenshots/lab04-shots/pulumi%20up.png) + +- SSH connection to VM + +![](./screenshots/lab04-shots/pulumi%20ssh.png) + +### Public IP of Pulumi-created VM + +```bash +(venv) fountainer@Veronicas-MacBook-Air pulumi % pulumi stack output + +Enter your passphrase to unlock config/secrets + (set PULUMI_CONFIG_PASSPHRASE or PULUMI_CONFIG_PASSPHRASE_FILE to remember): +Enter your passphrase to unlock config/secrets +Current stack outputs (2): + OUTPUT VALUE + external_ip 93.77.185.195 + internal_ip 192.168.10.5 +``` +### SSH connection + +(I reused the key from the terraform config) + +```bash +ssh -i ~/.ssh/terraform-vm-key ubuntu@93.77.185.195 +``` + +![](./screenshots/lab04-shots/pulumi%20ssh.png) + +## Terraform vs Pulumi Comparison + +### Ease of Learning: Which was easier to learn and why? + +- Documentation for Terraform was easier to find (for me), but Polumi was more familiar to work with. I also felt like Polumni's config is less complex. + +### Code Readability: Which is more readable for you? + +- Terraform + +### Debugging: Which was easier to debug when things went wrong? + +- Terraform, plan command was really useful + +### Documentation: Which has better docs and examples? + +- Terraform + +### Use Case: When would you use Terraform? When Pulumi? + +- Pulumi is good for projects where you want to employ features that only conplex programming languages can provide. Terraform is good for standardized infrastructure. + +### Code differences (HCL vs Python/TypeScript) + +- Terraform uses declarative HCL with blocks and attributes, while Pulumi uses imperative Python/TypeScript with function calls, objects, and full programming language features for resource creation and logic. + +### Which tool you prefer and why + +- I liked Terraform more (partially because on this step I was creating a vm in the cloud for the first time, but doing the same with Palumi was quite boring), I like the declarative languages, and they seem to be intuitively understandable. + +## Lab 5 Preparation & Cleanup + +### Are you keeping your VM for Lab 5? (Yes/No) + +- Yes + +### If yes: Which VM (Terraform or Pulumi created)? + +- Palumi, but I kind of contemplating on returning to Terraform... + +### VM Status + +![](./screenshots/lab04-shots/vm%20status.png) + + + + + diff --git a/app_python/docs/LAB05.md b/app_python/docs/LAB05.md new file mode 100644 index 0000000000..f18d4db760 --- /dev/null +++ b/app_python/docs/LAB05.md @@ -0,0 +1,306 @@ +# Documentation + +## Architecture Overview + +### Ansible version used + +core 2.20.2 + +### Target VM OS and version + +linux, ubuntu-2204-lts + +### Role structure diagram or explanation + +``` +roles/ +├─ web_app/ # deploying the application +│ ├─ defaults/main.yml # default variables: container_port, restart_policy, app_env, etc +│ ├─ handlers/main.yml # handlers, for example, restart container +│ └─ tasks/main.yml # deployment tasks +│ +├─ docker/ # docker setup/configuration +│ ├─ defaults/main.yml # defaults for docker config +│ ├─ handlers/main.yml # docker handlers +│ └─ tasks/main.yml # tasks to install and configure docker +│ +├─ common/ # general tasks +│ ├─ defaults/main.yml # default variables for common tasks +│ ├─ handlers/main.yml # handlers for common tasks +│ └─ tasks/main.yml # general-purpose tasks shared across roles +``` + +### Why roles instead of monolithic playbooks? + +- Roles can be used across different projects, thay are easy to configure and control, as well as to change if needed. + +## Roles Documentation + +### Common + +- Purpose: installs common packages and sets system timezone +- Variables: common_packages (default: vim, git, curl, python3-pip, htop), timezone_name (default: Europe/Moscow) +- Handlers: doesn't have +- Dependencies: doesn't have + +### Docker + +- Purpose: installs and configures docker engine, ensures service is running, adds user to docker group, and sets up python for ansible +- Variables: docker_packages (docker-ce, docker-ce-cli, containerd.io), docker_user (default: ubuntu), docker_gpg_url, docker_repo +- Handlers: restart docker – restarts docker service when notified +- Dependencies: doesn't have + +### web_app + +- Purpose: deploys the application container: logs in to Docker Hub, pulls the image, stops/removes old container, runs new container, waits for it to be ready, and verifies health +- Variables: Vaulted: dockerhub_username, dockerhub_password, app_name, docker_image_tag, app_port, app_container_name; Defaults: container_port, restart_policy, app_env +- Handlers: restart app container – restarts the application container when notified +- Dependencies: depends on Docker being installed and configured (accomplished with docker role) + +## Idempotency Demonstration + +### Terminal output from FIRST provision.yml run + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ansible-playbook playbooks/provision.yml + +PLAY [Provision web servers] ********************************************************************************************************************************************************* + +TASK [Gathering Facts] *************************************************************************************************************************************************************** +ok: [terraform] + +TASK [common : Update apt cache] ***************************************************************************************************************************************************** +changed: [terraform] + +TASK [common : Install common packages] ********************************************************************************************************************************************** +changed: [terraform] + +TASK [common : Ensure timezone is set] *********************************************************************************************************************************************** +changed: [terraform] + +TASK [docker : Install prerequisites] ************************************************************************************************************************************************ +ok: [terraform] + +TASK [docker : Add Docker GPG key] *************************************************************************************************************************************************** +changed: [terraform] + +TASK [docker : Add Docker APT repository] ******************************************************************************************************************************************** +[WARNING]: Deprecation warnings can be disabled by setting `deprecation_warnings=False` in ansible.cfg. +[DEPRECATION WARNING]: INJECT_FACTS_AS_VARS default to `True` is deprecated, top-level facts will not be auto injected after the change. This feature will be removed from ansible-core version 2.24. +Origin: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/docker/defaults/main.yml:7:14 + +5 docker_user: "ubuntu" +6 docker_gpg_url: "https://download.docker.com/linux/ubuntu/gpg" +7 docker_repo: "deb [arch=amd64] https://download.docker.com/linux/ubuntu {{ ansible_distribution_release }} stable" + ^ column 14 + +Use `ansible_facts["fact_name"]` (no `ansible_` prefix) instead. + +changed: [terraform] + +TASK [docker : Install Docker packages] ********************************************************************************************************************************************** +changed: [terraform] + +TASK [docker : Ensure Docker service is running] ************************************************************************************************************************************* +ok: [terraform] + +TASK [docker : Add user to Docker group] ********************************************************************************************************************************************* +changed: [terraform] + +TASK [docker : Install python3-docker for Ansible Docker modules] ******************************************************************************************************************** +changed: [terraform] + +RUNNING HANDLER [docker : restart docker] ******************************************************************************************************************************************** +changed: [terraform] + +PLAY RECAP *************************************************************************************************************************************************************************** +terraform : ok=12 changed=9 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 + +(devops) fountainer@Veronicas-MacBook-Air ansible % +``` + +### Terminal output from SECOND provision.yml run + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ansible-playbook playbooks/provision.yml + +PLAY [Provision web servers] ********************************************************************************************************************************************************* + +TASK [Gathering Facts] *************************************************************************************************************************************************************** +ok: [terraform] + +TASK [common : Update apt cache] ***************************************************************************************************************************************************** +ok: [terraform] + +TASK [common : Install common packages] ********************************************************************************************************************************************** +ok: [terraform] + +TASK [common : Ensure timezone is set] *********************************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Install prerequisites] ************************************************************************************************************************************************ +ok: [terraform] + +TASK [docker : Add Docker GPG key] *************************************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Add Docker APT repository] ******************************************************************************************************************************************** +[WARNING]: Deprecation warnings can be disabled by setting `deprecation_warnings=False` in ansible.cfg. +[DEPRECATION WARNING]: INJECT_FACTS_AS_VARS default to `True` is deprecated, top-level facts will not be auto injected after the change. This feature will be removed from ansible-core version 2.24. +Origin: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/docker/defaults/main.yml:7:14 + +5 docker_user: "ubuntu" +6 docker_gpg_url: "https://download.docker.com/linux/ubuntu/gpg" +7 docker_repo: "deb [arch=amd64] https://download.docker.com/linux/ubuntu {{ ansible_distribution_release }} stable" + ^ column 14 + +Use `ansible_facts["fact_name"]` (no `ansible_` prefix) instead. + +ok: [terraform] + +TASK [docker : Install Docker packages] ********************************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Ensure Docker service is running] ************************************************************************************************************************************* +ok: [terraform] + +TASK [docker : Add user to Docker group] ********************************************************************************************************************************************* +ok: [terraform] + +TASK [docker : Install python3-docker for Ansible Docker modules] ******************************************************************************************************************** +ok: [terraform] + +PLAY RECAP *************************************************************************************************************************************************************************** +terraform : ok=11 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 + +(devops) fountainer@Veronicas-MacBook-Air ansible % +``` + +### Analysis: What changed first time? What didn't change second time? + +- first run made actual changes to install and configure packages/services; second run found everything already in desired state, so no changes + +### What makes your roles idempotent? + +- all tasks use Ansible modules that check state before making changes, ensuring applying the same playbook multiple times does not alter already-correct configuration + +## Ansible Vault Usage + +### How you store credentials securely + +- secrets like dockerhub username/token etc are saved in encrypted files (group_vars/all.yml) using ansible-vault create + +### Vault password management strategy + +- use a dedicated vault password file (~/.vault_pass.txt) or just type password manually with --ask-vault-pass + +### Example of encrypted file (show it's encrypted!) + +![](./screenshots/lab05-shots/encrypted.png) + +### Why Ansible Vault is important + +- keeps sensitive data safe, prevents accidental exposure in repos or logs, allows secure automation + + +## Deployment Verification + +### Terminal output from deploy.yml run + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ansible-playbook playbooks/deploy.yml --extra-vars @./group_vars/all.yml + +PLAY [Deploy application] **************************************************************************************************************** + +TASK [Gathering Facts] ******************************************************************************************************************* +ok: [terraform] + +TASK [web_app : Show Docker password] ************************************************************************************************* +ok: [terraform] => { + "container_port": "12345" +} + +TASK [web_app : Log in to Docker Hub] ************************************************************************************************* +ok: [terraform] + +TASK [web_app : Pull Docker image] **************************************************************************************************** +ok: [terraform] + +TASK [web_app : Stop existing container (if running)] ********************************************************************************* +changed: [terraform] + +TASK [web_app : Remove old container (if exists)] ************************************************************************************* +changed: [terraform] + +TASK [web_app : Run new container] **************************************************************************************************** +changed: [terraform] + +TASK [web_app : Wait for application to be ready] ************************************************************************************* +ok: [terraform] + +TASK [web_app : Verify health endpoint] *********************************************************************************************** +ok: [terraform] + +RUNNING HANDLER [web_app : restart app container] ************************************************************************************* +ok: [terraform] + +PLAY RECAP ******************************************************************************************************************************* +terraform : ok=10 changed=3 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 + +``` + +### Container status: docker ps output + +```bash +Last login: Thu Feb 26 23:56:36 2026 from 45.12.151.45 +ubuntu@fhmebroid75qocec3dc3:~$ docker ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +bf2d264719af fountainer/my-app:latest "python app.py" About a minute ago Up About a minute 0.0.0.0:8080->12345/tcp my-app +ubuntu@fhmebroid75qocec3dc3:~$ +``` + +### Health check verification: curl outputs + +```bash +ubuntu@fhmebroid75qocec3dc3:~$ curl http://127.0.0.1:8080/health +{ + "status": "healthy", + "timestamp": "2026-02-26T20:58:46.335570", + "uptime_seconds": 134 +} +``` + +### Handler execution (if any) + +```bash +RUNNING HANDLER [web_app : restart app container] ************************************************************************************* +ok: [terraform] +``` + +## Key Decisions + +### Why use roles instead of plain playbooks? + +- roles can be used across different projects, thay are easy to configure and control, as well as to change if needed + +### How do roles improve reusability? + +- roles define tasks, defaults, and handlers so they can be reused across multiple playbooks or projects + +### What makes a task idempotent? + +- changes are made only when a system is not already in a needed state + +### How do handlers improve efficiency? + +- handlers run only when notified, avoiding repeated or unnecessary actions like service restarts + +### Why is Ansible Vault necessary? + +- vault encrypts sensitive data (passwords, tokens) from ending up in playbooks, logs, or git + +## Challenges + +- it was really hard for me to configure the internet access from my pulumi VM on yandex cloud. turned out it was kinda impossible so I returned to my terraform VM + +- while trying to run ```bash ansible-playbook playbooks/deploy.yml --ask-vault-pass``` ansible didn't see my vaulted variables \ No newline at end of file diff --git a/app_python/docs/LAB06.md b/app_python/docs/LAB06.md new file mode 100644 index 0000000000..6d86869cca --- /dev/null +++ b/app_python/docs/LAB06.md @@ -0,0 +1,868 @@ +# Documentation + +## Overview (What you accomplished and technologies used) + +- My stack consisted of Ansible core 2.20.2, Docker Compose 2.39.2, Jinja 3.1.6, python 3.11.9. +- I've accomplished refactoring the roles for using with docker-compose, implemented a wipe logic, and set up a new CI/CD worflow. + +## Blocks & Tags (Block usage in each role, tag strategy, execution examples with screenshots) + +All tags are made for quick understanding of the block usage. + +### Common role + +- block with package installation tasks (tag: packages) +- block with user creation (tag: users) +- block with timezone set up (tag: timezone) + +### Docker role + +- block with docker installation and set up (tag: docker_install) +- block with docker configuration (tag: docker_config) + +### Web-app role + +- block for app deployment with docker compose and possible wipe logic (from wipe.yaml with tag web_app_wipe), (tags: app_deploy, compose) + +## Screenshots and terminal outputs + +### Test provision with only docker +![](./screenshots/lab06-shots/Test%20provision%20with%20only%20docker.png) + +### Skip common role +![](./screenshots/lab06-shots/Skip%20common%20role.png) + +### Install packages only across all roles +![](./screenshots/lab06-shots/Install%20packages%20only%20across%20all%20roles.png) + +### Check mode to see what would run +![](./screenshots/lab06-shots/Check%20mode%20to%20see%20what%20would%20run.png) + +### Run only docker installation tasks +![](./screenshots/lab06-shots/Run%20only%20docker%20installation%20tasks.png) + +### Error handling with rescue block triggered + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ansible-playbook playbooks/provision.yml --tags "docker_install" + +PLAY [Provision web servers] ******************************************************************************************************************************************** + +TASK [Gathering Facts] ************************************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Install prerequisites] *********************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Add Docker GPG key] ************************************************************************************************************************************** +[ERROR]: Task failed: Module failed: unknown url type: 'blabla' +Origin: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/docker/tasks/main.yml:14:7 + +12 state: present +13 update_cache: yes +14 - name: Add Docker GPG key + ^ column 7 + +fatal: [terraform]: FAILED! => {"changed": false, "msg": "unknown url type: 'blabla'", "status": -1, "url": "blabla"} + +TASK [docker : Wait before retry] *************************************************************************************************************************************** +Pausing for 10 seconds +(ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort) +ok: [terraform] + +TASK [docker : Retry apt update] **************************************************************************************************************************************** +changed: [terraform] + +TASK [docker : Retry adding Docker GPG key] ***************************************************************************************************************************** +ok: [terraform] + +TASK [docker : ensure docker service is enabled] ************************************************************************************************************************ +ok: [terraform] + +PLAY RECAP ************************************************************************************************************************************************************** +terraform : ok=6 changed=1 unreachable=0 failed=0 skipped=0 rescued=1 ignored=0 +``` + +### List all available tags + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ansible-playbook playbooks/provision.yml --list-tags + +playbook: playbooks/provision.yml + + play #1 (webservers): Provision web servers TAGS: [] + TASK TAGS: [common, docker, docker_config, docker_install, packages, timezone, users] +``` + +## Docker Compose Migration (Template structure, role dependencies, before/after comparison) + +### Comparison + +- docker-compose provides richer functionality to set up env variables, dependencies, and configs, compared to just the docker container + +- docker-compose.yaml.j2 + +```yml +version: '{{ docker_compose_version }}' + +services: + {{ app_name }}: + image: {{ web_app_docker_image }}:{{ web_app_docker_tag }} + + ports: + - "{{ app_port }}:{{ app_internal_port }}" + + restart: unless-stopped + + environment: +{% for key, value in web_app_env.items() %} + {{ key }}: "{{ value }}" +{% endfor %} + + networks: + - {{ app_name }}_network + +networks: + {{ app_name }}_network: + driver: bridge +``` + +### First run + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ansible-playbook playbooks/deploy.yml --extra-vars @./group_vars/all.yml + +PLAY [Deploy application] ***************************************************************************************************************************************** + +TASK [Gathering Facts] ******************************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Install prerequisites] ***************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Add Docker GPG key] ******************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Add Docker APT repository] ************************************************************************************************************************* +[WARNING]: Deprecation warnings can be disabled by setting `deprecation_warnings=False` in ansible.cfg. +[DEPRECATION WARNING]: INJECT_FACTS_AS_VARS default to `True` is deprecated, top-level facts will not be auto injected after the change. This feature will be removed from ansible-core version 2.24. +Origin: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/docker/defaults/main.yml:7:14 + +5 docker_user: "ubuntu" +6 docker_gpg_url: "https://download.docker.com/linux/ubuntu/gpg" +7 docker_repo: "deb [arch=amd64] https://download.docker.com/linux/ubuntu {{ ansible_distribution_release }} stable" + ^ column 14 + +Use `ansible_facts["fact_name"]` (no `ansible_` prefix) instead. + +ok: [terraform] + +TASK [docker : Install Docker packages] *************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Install python3-docker for Ansible Docker modules] ************************************************************************************************* +ok: [terraform] + +TASK [docker : ensure docker service is enabled] ****************************************************************************************************************** +ok: [terraform] + +TASK [docker : Add user to Docker group] ************************************************************************************************************************** +ok: [terraform] + +TASK [web_app : Create application directory] ********************************************************************************************************************* +ok: [terraform] + +TASK [web_app : Template docker-compose.yml] ********************************************************************************************************************** +changed: [terraform] + +TASK [web_app : Deploy with Docker Compose] *********************************************************************************************************************** +[WARNING]: Docker compose: unknown None: /opt/my-app/docker-compose.yml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion +changed: [terraform] + +TASK [web_app : Log deployment attempt] *************************************************************************************************************************** +[DEPRECATION WARNING]: INJECT_FACTS_AS_VARS default to `True` is deprecated, top-level facts will not be auto injected after the change. This feature will be removed from ansible-core version 2.24. +Origin: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/main.yml:33:18 + +31 - name: Log deployment attempt +32 copy: +33 content: "Docker Compose deployment attempted on {{ ansible_date_time.iso8601 }}" + ^ column 18 + +Use `ansible_facts["fact_name"]` (no `ansible_` prefix) instead. + +changed: [terraform] + +PLAY RECAP ******************************************************************************************************************************************************** +terraform : ok=12 changed=3 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 +``` + +### Second run removed "changed" status of some fields (not with the current time) + +```bash +TASK [web_app : Template docker-compose.yml] ********************************************************************************************************************** +ok: [terraform] + +TASK [web_app : Deploy with Docker Compose] *********************************************************************************************************************** +[WARNING]: Docker compose: unknown None: /opt/my-app/docker-compose.yml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion +ok: [terraform] +``` + +### Verifying on target VM + +```bash +ubuntu@fhmebroid75qocec3dc3:~$ docker ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +7c279d0b3c18 fountainer/my-app:latest "python app.py" 10 minutes ago Up 10 minutes 0.0.0.0:1999->12345/tcp, [::]:1999->12345/tcp my-app-my-app-1 +0a0701a21e3a 9582a1fe4631 "python app.py" 25 hours ago Up 25 hours 0.0.0.0:8080->12345/tcp my-app +ubuntu@fhmebroid75qocec3dc3:~$ curl http://localhost:1999 +{ + "message": { + "endpoints": [ + { + "description": "Service information", + "method": "GET", + "path": "/" + }, + { + "description": "Health check", + "method": "GET", + "path": "/health" + } + ], + "request": { + "client_ip": "127.0.0.1", + "method": "GET", + "path": "/", + "port": 12345, + "user_agent": "curl/7.81.0" + }, + "runtime": { + "current_time": "2026-01-07T14:30:00.000Z", + "timezone": "UTC", + "uptime_human": "1 hour, 0 minutes", + "uptime_seconds": { + "human": "0 hours, 0 minutes", + "seconds": 0 + } + }, + "service": { + "debug status": true, + "description": "DevOps course info service", + "framework": "Flask", + "name": "devops-info-service", + "version": "1.0.0" + }, + "system": { + "architecture": "x86_64", + "cpu_count": 8, + "hostname": "7c279d0b3c18", + "platform": "Linux", + "platform_version": "Ubuntu 24.04", + "python_version": "3.13.12" + } + } +} +ubuntu@fhmebroid75qocec3dc3:~$ +``` + +## Wipe Logic (Implementation details, variable + tag approach, test results) + +- Implementation details can be seen in ansible/roles/web-app/tasks/wipe.yml. + +- The tag is web_app_wipe, the task is triggered by "when: web_app_wipe | bool" + +- Variables: "{{ web_app_compose_project_dir }}", "{{ ansible_check_mode }}", {{ app_name }} + +### Scenario 1: Normal deployment (wipe should NOT run) + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ansible-playbook playbooks/deploy.yml --extra-vars @./group_vars/all.yml + +PLAY [Deploy application] ***************************************************************************************************************************************** + +TASK [Gathering Facts] ******************************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Install prerequisites] ***************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Add Docker GPG key] ******************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Add Docker APT repository] ************************************************************************************************************************* +[WARNING]: Deprecation warnings can be disabled by setting `deprecation_warnings=False` in ansible.cfg. +[DEPRECATION WARNING]: INJECT_FACTS_AS_VARS default to `True` is deprecated, top-level facts will not be auto injected after the change. This feature will be removed from ansible-core version 2.24. +Origin: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/docker/defaults/main.yml:7:14 + +5 docker_user: "ubuntu" +6 docker_gpg_url: "https://download.docker.com/linux/ubuntu/gpg" +7 docker_repo: "deb [arch=amd64] https://download.docker.com/linux/ubuntu {{ ansible_distribution_release }} stable" + ^ column 14 + +Use `ansible_facts["fact_name"]` (no `ansible_` prefix) instead. + +ok: [terraform] + +TASK [docker : Install Docker packages] *************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Install python3-docker for Ansible Docker modules] ************************************************************************************************* +ok: [terraform] + +TASK [docker : ensure docker service is enabled] ****************************************************************************************************************** +ok: [terraform] + +TASK [docker : Add user to Docker group] ************************************************************************************************************************** +ok: [terraform] + +TASK [web_app : Create application directory] ********************************************************************************************************************* +ok: [terraform] + +TASK [web_app : Template docker-compose.yml] ********************************************************************************************************************** +ok: [terraform] + +TASK [web_app : Include wipe tasks] ******************************************************************************************************************************* +included: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/wipe.yml for terraform + +TASK [web_app : Stop and remove containers] *********************************************************************************************************************** +skipping: [terraform] + +TASK [web_app : Remove docker-compose file] *********************************************************************************************************************** +skipping: [terraform] + +TASK [web_app : Remove application directory] ********************************************************************************************************************* +skipping: [terraform] + +TASK [web_app : Log wipe completion] ****************************************************************************************************************************** +skipping: [terraform] + +TASK [web_app : Deploy with Docker Compose] *********************************************************************************************************************** +[WARNING]: Docker compose: unknown None: /opt/my-app/docker-compose.yml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion +ok: [terraform] + +TASK [web_app : Log deployment attempt] *************************************************************************************************************************** +[DEPRECATION WARNING]: INJECT_FACTS_AS_VARS default to `True` is deprecated, top-level facts will not be auto injected after the change. This feature will be removed from ansible-core version 2.24. +Origin: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/main.yml:38:18 + +36 - name: Log deployment attempt +37 copy: +38 content: "Docker Compose deployment attempted on {{ ansible_date_time.iso8601 }}" + ^ column 18 + +Use `ansible_facts["fact_name"]` (no `ansible_` prefix) instead. + +changed: [terraform] + +PLAY RECAP ******************************************************************************************************************************************************** +terraform : ok=13 changed=1 unreachable=0 failed=0 skipped=4 rescued=0 ignored=0 + +(devops) fountainer@Veronicas-MacBook-Air ansible % +``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ssh ubuntu@93.77.181.173 "docker ps" +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +7c279d0b3c18 fountainer/my-app:latest "python app.py" 21 minutes ago Up 21 minutes 0.0.0.0:1999->12345/tcp, [::]:1999->12345/tcp my-app-my-app-1 +0a0701a21e3a 9582a1fe4631 "python app.py" 25 hours ago Up 25 hours 0.0.0.0:8080->12345/tcp my-app +(devops) fountainer@Veronicas-MacBook-Air ansible % +``` + +### Scenario 2: Wipe only (remove existing deployment) + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ansible-playbook playbooks/deploy.yml -e "web_app_wipe=true" --tags web_app_wipe --extra-vars @./group_vars/all.yml + +PLAY [Deploy application] ***************************************************************************************************************************************** + +TASK [Gathering Facts] ******************************************************************************************************************************************** +ok: [terraform] + +TASK [web_app : Include wipe tasks] ******************************************************************************************************************************* +included: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/wipe.yml for terraform + +TASK [web_app : Stop and remove containers] *********************************************************************************************************************** +[ERROR]: Task failed: Module failed: "/opt/my-app" is not a directory +Origin: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/wipe.yml:5:7 + +3 block: +4 +5 - name: Stop and remove containers + ^ column 7 + +fatal: [terraform]: FAILED! => {"changed": false, "msg": "\"/opt/my-app\" is not a directory"} +...ignoring + +TASK [web_app : Remove docker-compose file] *********************************************************************************************************************** +ok: [terraform] + +TASK [web_app : Remove application directory] ********************************************************************************************************************* +ok: [terraform] + +TASK [web_app : Log wipe completion] ****************************************************************************************************************************** +ok: [terraform] => { + "msg": "Application my-app wiped successfully" +} + +PLAY RECAP ******************************************************************************************************************************************************** +terraform : ok=6 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=1 +``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ssh ubuntu@93.77.181.173 "docker ps" +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +(devops) fountainer@Veronicas-MacBook-Air ansible % ssh ubuntu@93.77.181.173 "ls /opt" +containerd +(devops) fountainer@Veronicas-MacBook-Air ansible % +``` + +### Scenario 3: Clean reinstallation (wipe → deploy) + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ansible-playbook playbooks/deploy.yml -e "web_app_wipe=true" --extra-vars @./group_vars/all.yml + +PLAY [Deploy application] ***************************************************************************************************************************************** + +TASK [Gathering Facts] ******************************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Install prerequisites] ***************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Add Docker GPG key] ******************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Add Docker APT repository] ************************************************************************************************************************* +[WARNING]: Deprecation warnings can be disabled by setting `deprecation_warnings=False` in ansible.cfg. +[DEPRECATION WARNING]: INJECT_FACTS_AS_VARS default to `True` is deprecated, top-level facts will not be auto injected after the change. This feature will be removed from ansible-core version 2.24. +Origin: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/docker/defaults/main.yml:7:14 + +5 docker_user: "ubuntu" +6 docker_gpg_url: "https://download.docker.com/linux/ubuntu/gpg" +7 docker_repo: "deb [arch=amd64] https://download.docker.com/linux/ubuntu {{ ansible_distribution_release }} stable" + ^ column 14 + +Use `ansible_facts["fact_name"]` (no `ansible_` prefix) instead. + +ok: [terraform] + +TASK [docker : Install Docker packages] *************************************************************************************************************************** +ok: [terraform] + +TASK [docker : Install python3-docker for Ansible Docker modules] ************************************************************************************************* +ok: [terraform] + +TASK [docker : ensure docker service is enabled] ****************************************************************************************************************** +ok: [terraform] + +TASK [docker : Add user to Docker group] ************************************************************************************************************************** +ok: [terraform] + +TASK [web_app : Include wipe tasks] ******************************************************************************************************************************* +included: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/wipe.yml for terraform + +TASK [web_app : Stop and remove containers] *********************************************************************************************************************** +[ERROR]: Task failed: Module failed: "/opt/my-app" is not a directory +Origin: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/wipe.yml:5:7 + +3 block: +4 +5 - name: Stop and remove containers + ^ column 7 + +fatal: [terraform]: FAILED! => {"changed": false, "msg": "\"/opt/my-app\" is not a directory"} +...ignoring + +TASK [web_app : Remove docker-compose file] *********************************************************************************************************************** +ok: [terraform] + +TASK [web_app : Remove application directory] ********************************************************************************************************************* +ok: [terraform] + +TASK [web_app : Log wipe completion] ****************************************************************************************************************************** +ok: [terraform] => { + "msg": "Application my-app wiped successfully" +} + +TASK [web_app : Create application directory] ********************************************************************************************************************* +changed: [terraform] + +TASK [web_app : Template docker-compose.yml] ********************************************************************************************************************** +changed: [terraform] + +TASK [web_app : Deploy with Docker Compose] *********************************************************************************************************************** +[WARNING]: Docker compose: unknown None: /opt/my-app/docker-compose.yml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion +changed: [terraform] + +TASK [web_app : Log deployment attempt] *************************************************************************************************************************** +[DEPRECATION WARNING]: INJECT_FACTS_AS_VARS default to `True` is deprecated, top-level facts will not be auto injected after the change. This feature will be removed from ansible-core version 2.24. +Origin: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/main.yml:37:18 + +35 - name: Log deployment attempt +36 copy: +37 content: "Docker Compose deployment attempted on {{ ansible_date_time.iso8601 }}" + ^ column 18 + +Use `ansible_facts["fact_name"]` (no `ansible_` prefix) instead. + +changed: [terraform] + +PLAY RECAP ******************************************************************************************************************************************************** +terraform : ok=17 changed=4 unreachable=0 failed=0 skipped=0 rescued=0 ignored=1 +``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ssh ubuntu@93.77.181.173 "docker ps" +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +167ea730bdc1 fountainer/my-app:latest "python app.py" 20 seconds ago Up 19 seconds 0.0.0.0:1999->12345/tcp, [::]:1999->12345/tcp my-app-my-app-1 +``` +### Scenario 4: Safety checks (should NOT wipe) + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ansible-playbook playbooks/deploy.yml --tags web_app_wipe --extra-vars @./group_vars/all.yml + +PLAY [Deploy application] ***************************************************************************************************************************************** + +TASK [Gathering Facts] ******************************************************************************************************************************************** +ok: [terraform] + +TASK [web_app : Include wipe tasks] ******************************************************************************************************************************* +included: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/wipe.yml for terraform + +TASK [web_app : Stop and remove containers] *********************************************************************************************************************** +skipping: [terraform] + +TASK [web_app : Remove docker-compose file] *********************************************************************************************************************** +skipping: [terraform] + +TASK [web_app : Remove application directory] ********************************************************************************************************************* +skipping: [terraform] + +TASK [web_app : Log wipe completion] ****************************************************************************************************************************** +skipping: [terraform] + +PLAY RECAP ******************************************************************************************************************************************************** +terraform : ok=2 changed=0 unreachable=0 failed=0 skipped=4 rescued=0 ignored=0 + +(devops) fountainer@Veronicas-MacBook-Air ansible % +``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air ansible % ansible-playbook playbooks/deploy.yml -e "web_app_wipe=true" --tags web_app_wipe --extra-vars @./group_vars/all.yml + +PLAY [Deploy application] ***************************************************************************************************************************************** + +TASK [Gathering Facts] ******************************************************************************************************************************************** +ok: [terraform] + +TASK [web_app : Include wipe tasks] ******************************************************************************************************************************* +included: /Users/fountainer/uni/devops/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/wipe.yml for terraform + +TASK [web_app : Stop and remove containers] *********************************************************************************************************************** +[WARNING]: Docker compose: unknown None: /opt/my-app/docker-compose.yml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion +changed: [terraform] + +TASK [web_app : Remove docker-compose file] *********************************************************************************************************************** +changed: [terraform] + +TASK [web_app : Remove application directory] ********************************************************************************************************************* +changed: [terraform] + +TASK [web_app : Log wipe completion] ****************************************************************************************************************************** +ok: [terraform] => { + "msg": "Application my-app wiped successfully" +} + +PLAY RECAP ******************************************************************************************************************************************************** +terraform : ok=6 changed=3 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 +``` + +### App running after complete reinstall + +![](./screenshots/lab06-shots/app%20running%20after%20clean%20reinstall.png) + + +## CI/CD Integration (Workflow architecture, setup steps, evidence of automated deployments) + +### Workflow + +- this workflow runs ansible-lint on pushes and pr’s first to catch errors, then deploys the app automatically on master/lab06 branches + +### Setup steps + +- setup steps include checking out code, installing python and ansible, configuring ssh with github secrets, decoding vault vars, and running the playbook remotely + +### Evidence + +- evidence of automated deployment is in the deploy job: it ssh’s to the vm, runs ansible-playbook with vault and extra vars, then verifies the app with curl requests + +![](./screenshots/lab06-shots/ci:cd%20success.png) + +Terminal output: + +```bash +ssh -i ~/.ssh/terraform-vm-key ubuntu@*** "echo connected" + + echo '***' > /tmp/vault_pass + cd app_python/ansible + + ansible-playbook playbooks/deploy.yml \ + -i inventory/hosts.ini \ + --vault-password-file /tmp/vault_pass \ + --extra-vars @./group_vars/all.yml + + rm /tmp/vault_pass + shell: /usr/bin/bash -e {0} + env: + pythonLocation: /opt/hostedtoolcache/Python/3.12.12/x64 + PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.12.12/x64/lib/pkgconfig + Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.12/x64 + Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.12/x64 + Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.12/x64 + LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.12.12/x64/lib +connected + +PLAY [Deploy application] ****************************************************** + +TASK [Gathering Facts] ********************************************************* +ok: [terraform] + +TASK [docker : Install prerequisites] ****************************************** +ok: [terraform] + +TASK [docker : Add Docker GPG key] ********************************************* +ok: [terraform] +Warning: : Deprecation warnings can be disabled by setting `deprecation_warnings=False` in ansible.cfg. + +TASK [docker : Add Docker APT repository] ************************************** +[DEPRECATION WARNING]: INJECT_FACTS_AS_VARS default to `True` is deprecated, top-level facts will not be auto injected after the change. This feature will be removed from ansible-core version 2.24. +Origin: /home/runner/work/DevOps-Core-Course/DevOps-Core-Course/app_python/ansible/roles/docker/defaults/main.yml:8:14 + +6 docker_user: "ubuntu" +7 docker_gpg_url: "https://download.docker.com/linux/ubuntu/gpg" +8 docker_repo: "deb [arch=amd64] https://download.docker.com/linux/ubuntu {{ ansible_distribution_release }} stable" + ^ column 14 + +Use `ansible_facts["fact_name"]` (no `ansible_` prefix) instead. + +ok: [terraform] + +TASK [docker : Install Docker packages] **************************************** +ok: [terraform] + +TASK [docker : Install python3-docker for Ansible Docker modules] ************** +ok: [terraform] + +TASK [docker : Ensure docker service is enabled] ******************************* +ok: [terraform] + +TASK [docker : Add user to Docker group] *************************************** +ok: [terraform] + +TASK [web_app : Include wipe tasks] ******************************************** +included: /home/runner/work/DevOps-Core-Course/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/wipe.yml for terraform + +TASK [web_app : Stop and remove containers] ************************************ +skipping: [terraform] + +TASK [web_app : Remove docker-compose file] ************************************ +skipping: [terraform] + +TASK [web_app : Remove application directory] ********************************** +skipping: [terraform] + +TASK [web_app : Log wipe completion] ******************************************* +skipping: [terraform] + +TASK [web_app : Create application directory] ********************************** +ok: [terraform] + +TASK [web_app : Template docker-compose.yml] *********************************** +ok: [terraform] + +TASK [web_app : Deploy with Docker Compose] ************************************ +Warning: : Docker compose: unknown None: /opt/my-app/docker-compose.yml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion +ok: [terraform] + +TASK [web_app : Log deployment attempt] **************************************** +[DEPRECATION WARNING]: INJECT_FACTS_AS_VARS default to `True` is deprecated, top-level facts will not be auto injected after the change. This feature will be removed from ansible-core version 2.24. +Origin: /home/runner/work/DevOps-Core-Course/DevOps-Core-Course/app_python/ansible/roles/web_app/tasks/main.yml:41:18 + +39 - name: Log deployment attempt +40 ansible.builtin.copy: +41 content: "Docker Compose deployment attempted on {{ ansible_date_time.iso8601 }}" + ^ column 18 + +Use `ansible_facts["fact_name"]` (no `ansible_` prefix) instead. + +changed: [terraform] + +PLAY RECAP ********************************************************************* +terraform : ok=13 changed=1 unreachable=0 failed=0 skipped=4 rescued=0 ignored=0 + + sleep 10 + curl -f http://***:1999 || exit 1 + curl -f http://***:1999/health || exit 1 + shell: /usr/bin/bash -e {0} + env: + pythonLocation: /opt/hostedtoolcache/Python/3.12.12/x64 + PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.12.12/x64/lib/pkgconfig + Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.12/x64 + Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.12/x64 + Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.12/x64 + LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.12.12/x64/lib + % Total % Received % Xferd Average Speed Time Time Time Current + Dload Upload Total Spent Left Speed + + 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 + 0 1058 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 +100 1058 100 1058 0 0 4059 0 --:--:-- --:--:-- --:--:-- 4053 +{ + "message": { + "endpoints": [ + { + "description": "Service information", + "method": "GET", + "path": "/" + }, + { + "description": "Health check", + "method": "GET", + "path": "/health" + } + ], + "request": { + "client_ip": "127.0.0.1", + "method": "GET", + "path": "/", + "port": 12345, + "user_agent": "curl/7.81.0" + }, + "runtime": { + "current_time": "2026-01-07T14:30:00.000Z", + "timezone": "UTC", + "uptime_human": "1 hour, 0 minutes", + "uptime_seconds": { + "human": "0 hours, 0 minutes", + "seconds": 0 + } + }, + "service": { + "debug status": true, + "description": "DevOps course info service", + "framework": "Flask", + "name": "devops-info-service", + "version": "1.0.0" + }, + "system": { + "architecture": "x86_64", + "cpu_count": 8, + "hostname": "8081285df89f", + "platform": "Linux", + "platform_version": "Ubuntu 24.04", + "python_version": "3.13.12" + } + } +} + % Total % Received % Xferd Average Speed Time Time Time Current + Dload Upload Total Spent Left Speed + + 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 +100 99 100 99 0 0 364 0 --:--:-- --:--:-- --:--:-- 365 +{ + "status": "healthy", + "timestamp": "2026-03-07T16:04:23.506918", + "uptime_seconds": 146470 +} +``` + +## Testing Results (All test scenarios, idempotency verification, application accessibility) + +- all testing results are provided in the corresponding sections above + +## Challenges & Solutions (Difficulties encountered and how you solved them) + +- I had a hard time making ssh connection work in the github actions and wasted 2 days after the deadline for this... it was eventually solved by generating new ssh pair and coniguring vm's authorised keys again. + +## Research Answers (All research questions answered with analysis) + +### 1.3 + +Q1: What happens if rescue block also fails? + +- if the rescue block fails, ansible just shows an error and moves on to the always block. it won’t stop the playbook completely + +Q2: Can you have nested blocks? + +- yes, you can nest blocks inside other blocks, each with their own rescue/always if needed + +Q3: How do tags inherit to tasks within blocks? + +- tags on a block automatically apply to all tasks inside, but you can override or add extra tags per task + +### 2.3 + +Q1: What's the difference between restart: always and restart: unless-stopped? + +- restart: always makes the container restart no matter what, even if you stop it manually. unless-stopped restarts it only if it crashes or docker restarts, but not if you stopped it yourself + +Q2: How do Docker Compose networks differ from Docker bridge networks? + +- docker compose networks are defined per project and let containers talk using service names. bridge networks are default docker networks, simpler and not tied to a compose project + +Q3: Can you reference Ansible Vault variables in the template? + +- yes, you can use ansible vault variables in templates by referencing them like any other ansible variable ({{ vault_var_name }}) + +### 2.5 + +Q1: Look up community.docker.docker_compose_v2 module + +- community.docker.docker_compose_v2 manages compose projects using docker compose v2 cli under the hood, can pull images, recreate services, and set project source + +Q2: Compare state: present vs other state options + +- state: present makes sure services are running, absent removes them, stopped just stops without removing, restarted forces a restart + +Q3: Understand recreate parameter options + +- recreate: auto only recreates changed containers, never won’t recreate, force always recreates even if unchanged + +### 3.6 + +Q1: Why use both variable AND tag? (Double safety mechanism) + +- using both variable and tag is double safety: the variable controls behavior in code, tag controls execution from command line + +Q2: What's the difference between never tag and this approach? + +- never tag completely ignores tasks unless explicitly forced, this approach lets you selectively run blocks with normal tags + +Q3: Why must wipe logic come BEFORE deployment in main.yml? (Clean reinstall scenario) + +- wipe logic must run first to remove old containers/configs so deployment starts clean, avoids conflicts or leftover data + +Q4: When would you want clean reinstallation vs. rolling update? + +- clean reinstall is good if configs or images changed, rolling update is better for small changes with minimal downtime + +Q5: How would you extend this to wipe Docker images and volumes too? + +- extend wipe by adding tasks that remove docker images (docker_image module) and volumes (docker_volume module) before deployment + +### 4.10 + +Q1: What are the security implications of storing SSH keys in GitHub Secrets? + +- storing ssh keys in github secrets is safe if encrypted, but exposure risk exists if repo or workflows are misconfigured + +Q2: How would you implement a staging → production deployment pipeline? + +- implement staging → production by having two environments, separate compose dirs, and deploy to staging first, then promote to production after tests pass + +Q3: What would you add to make rollbacks possible? + +- for rollbacks, keep previous compose files and image tags, and add tasks to revert to last known good version if deployment fails + +Q4: How does self-hosted runner improve security compared to GitHub-hosted? + +- self-hosted runners limit exposure because the runner machine is under your control, unlike github-hosted where VM is shared and short-lived \ No newline at end of file diff --git a/app_python/docs/LAB07.md b/app_python/docs/LAB07.md new file mode 100644 index 0000000000..f6df6dcf12 --- /dev/null +++ b/app_python/docs/LAB07.md @@ -0,0 +1,260 @@ +# Documentation + +## Architecture (diagram showing how components connect, and the data flow) + +```mermaid +flowchart LR + +subgraph Docker_Network["Docker Compose Network"] + + A[Promtail
port 9080
scrapes logs] + + B[Loki
port 3100
stores logs] + + C[Grafana
port 3000
visualizes logs] + +end + +D[Docker Engine
/var/lib/docker/containers
/var/run/docker.sock] + +D -->|discover containers
read logs| A + +A -->|push logs
http://loki:3100/loki/api/v1/push| B + +C -->|query logs
http://loki:3100| B +``` + +## Setup Guide (step-by-step deployment instructions) + +```bash +# make sure your docker compose is working +docker compose version +``` +```bash +# enter the monitoring directory +cd app_python/monitoring +``` +```bash +# deploy the containers +docker compose up -d +``` +Important! Make sure you have your .env file with secrets GF_PASSWORD and GF_EMAIL for Grafana authorization. + +## Configuration (explain your Loki/Promtail configs and why) + +### Configuration file snippets for Loki + +```bash +auth_enabled: false +# no authentication required +``` + +```bash +server: + http_listen_port: 3100 +# loki is listening on port 3100 +``` + +```bash +# common values are shared among all modules if not redefined explicitly +common: + path_prefix: /loki + storage: + # filesystem object store + filesystem: + chunks_directory: /loki/chunks + rules_directory: /loki/rules + # number of instances + replication_factor: 1 + # hashes are stored in ram + ring: + kvstore: + store: inmemory +``` + +```bash +# configures the schema for chunk index +schema_config: + configs: + # index buckets are created from this date + - from: 2026-03-01 + # index type + store: tsdb + object_store: filesystem + schema: v13 + index: + # prefix for all created indices + prefix: index_ + # the index is remade every 24 hours + period: 24h +``` + +```bash +# storage config for chunks +storage_config: + filesystem: + directory: /loki/chunks +``` +```bash +# logs are stored for 168 hours and then discarded +limits_config: + retention_period: 168h +``` + +```bash +# compactor merges small index shards for performance and deletes old logs +compactor: + working_directory: /loki/compactor + retention_enabled: true +``` + +### Configuration file snippets for Promtail + +```bash +server: + # listening port for promtail itself + http_listen_port: 9080 +``` +```bash +# positions help promtail to identify where it left of while reading the file +positions: + filename: "/tmp/positions.yaml" + sync_period: 10s + ignore_invalid_yaml: false +``` +```bash +# where promtail will push logs to +clients: + - url: http://loki:3100/loki/api/v1/push +``` +```bash +# discovery configs +scrape_configs: + - job_name: docker + docker_sd_configs: + - host: unix:///var/run/docker.sock + refresh_interval: 5s + # relabeling + relabel_configs: + - source_labels: ['__meta_docker_container_name'] + # regex helps to remove / from container names + regex: '/(.*)' + target_label: 'container' +``` + +## Application Logging (how you implemented JSON logging) + +I implemented logging using JsonFormatter from pythonjsonlogger.json. It has basic configured fields and I can add extra fields relating to the request from dedicated functions that handle connections. + +### Screenshot of JSON log output from your app + +![](./screenshots/lab07-shots/logs%20from%20the%20app.png) + +## Dashboard (explain each panel and the LogQL queries) + +### Screenshot showing logs from at least 3 containers in Grafana Explore + +![](./screenshots/lab07-shots/grafana_logs_3_containers.png) + +### Screenshots of Grafana showing logs from the app + +![](./screenshots/lab07-shots/grafana-app-name.png) + +![](./screenshots/lab07-shots/grafana-error.png) + +![](./screenshots/lab07-shots/grafana_get.png) + +### Screenshot of your dashboard showing all 4 panels with real data. + +I have 4 panels: +- All collected logs ("Logs from all apps") +- The rate of getting logs ("Logs rate") +- A pie chart that shows the relative size of logs with different errors ("Level statistics") +- All collected error logs ("Error logs") + +![](./screenshots/lab07-shots/grafana%20dashboard.png) + +### Example LogQL queries with explanations (At least 3 different LogQL queries that work) + +- all logs from the app: +- - {service_name="app-python"} +- access all logs from the app which level is error: +- - {service_name="app-python"} |= "ERROR" +- all logs where request method was GET: +- - {service_name="app-python"} | json | METHOD = `GET` +- relative size of logs by levels: +- - sum by (level) (count_over_time({service_name=~"app-.*"} | json [60m])) +- rate of logs: +- - sum by (service_name) (rate({service_name=~"app-.*"} [120m])) +- error logs: +- - {service_name=~"app-.*"} | json | LEVEL="ERROR" + +## Production Config (security measures, resources, retention) + +### Configuration file snippets + +```bash +# healthchecks for loki and grafana to verify that containers are running and everything is okay +healthcheck: + test: ["CMD-SHELL", "wget --no-verbose --tries=1 --spider http://localhost:3100/ready || exit 1"] + interval: 10s + timeout: 5s + retries: 5 + start_period: 10s +``` + +```bash +# resources limits: promtail, grafana, and app_python are pretty lightweight, but loki needs a lot of memory to store logs +deploy: + resources: + limits: + cpus: "1.50" + memory: 2G + reservations: + cpus: "0.50" + memory: 512M +``` + +```bash +# now grafana requires login authorization, it is configured with .env file with environment variables +environment: + - GF_AUTH_ANONYMOUS_ENABLED=false + - GF_SECURITY_ADMIN_PASSWORD=${GF_PASSWORD} + - GF_SECURITY_ADMIN_EMAIL=${GF_EMAIL} +``` + +### docker-compose ps showing all services healthy + +![](./screenshots/lab07-shots/healthy%20services.png) + +### Screenshot of Grafana login page (no anonymous access) + +![](./screenshots/lab07-shots/grafana_login.png) + +## Testing (commands to verify everything works) + +```bash +# check that the containers are up and healthy +docker compose ps +``` + +```bash +# check loki +curl http://localhost:3100/ready +``` + +```bash +# check promtail +curl http://localhost:9080/targets +``` + +```bash +# check grafana +open http://localhost:3000 +``` + +## Challenges (problems you encountered and solutions) + +- It was pretty hard for me to set up logging but after a long research it was done (I used python documentation and some guides to work out how JsonFormatter works with/without logging.BasicConfig()) + +- Also I was very confused about how to make promtail keep logs from a service with a specific label (I researched Stack Overflow and used AI a bit for this one) \ No newline at end of file diff --git a/app_python/docs/LAB08.md b/app_python/docs/LAB08.md new file mode 100644 index 0000000000..c9afdd3a36 --- /dev/null +++ b/app_python/docs/LAB08.md @@ -0,0 +1,144 @@ +# Documentation + +## Architecture - Diagram showing metric flow (app → Prometheus → Grafana) + +```mermaid +flowchart LR + +subgraph Docker_Network["Docker Compose Network"] + + A[app-python
exposes /metrics] + + B[Prometheus
scrapes metrics
stores time-series data] + + C[Grafana
port 3000
visualizes metrics] + +end + +A -->|exposes metrics endpoint
http://app-python:12345/metrics| B + +B -->|PromQL queries
data source| C +``` + + +### Comparison: metrics vs logs (Lab 7) - when to use each + +- we use logs to see what has happened and metric to see the quantities: how much and how often. + +## Application Instrumentation - What metrics you added and why + +### Screenshot of /metrics endpoint output + +![](./screenshots/lab08-shots/metrics%20for%20app%20logs.png) + +### Code showing metric definitions + +- you can see it in app.py +- sections: imports updated, Counter, Histogram, Gauge metrics defined, before request/after request decorators, metrics route decorator + +### Documentation explaining your metric choices + +- http_requests_total counts how many requests hit the service, so i can see overall traffic and usage patterns +- http_request_duration_seconds measures how long requests take, which helps spot slow endpoints or performance issues +- http_requests_in_progress tracks how many requests are being processed right now, useful for detecting load spikes +- endpoint_calls tracks how often each endpoint is used, so i can understand which parts of the service are actually used +- system_info_duration measures how long it takes to collect system info, mainly to check if that logic becomes slow over time + +## Prometheus Configuration + +### Screenshot of /targets page showing all targets UP + +![](./screenshots/lab08-shots/prometheous%20targets.png) + +### Screenshot of a successful PromQL query + +![](./screenshots/lab08-shots/successful%20query.png) + +### prometheus.yml configuration file + +- you can find it in ./app_python_monitoring/prometheous/prometheous.yml + +## Dashboard Walkthrough + +### Each panel's purpose and query + +- request rate — shows how many requests/sec the service gets per endpoint +[query: sum(rate(http_requests_total[5m])) by (endpoint)] + +- error rate — shows how many failed requests (4xx/5xx) happen per second +[query: sum(rate(http_requests_total{status_code=~"[45].."}[5m]))] + +- p95 latency — shows how slow requests are (95th percentile) +[query: histogram_quantile(0.95, rate(http_request_duration_seconds_bucket[5m]))] + +- latency heatmap — shows distribution of request durations +[query: rate(http_request_duration_seconds_bucket[5m])] + +- active requests — shows how many requests are currently being processed +[query: http_requests_in_progress] + +- status codes — shows distribution of responses (2xx, 4xx, 5xx) +[query: sum by (status_code) (rate(http_requests_total[5m]))] + +- service health — shows if the service is up (1) or down (0) +[query: up{job="app"}] + +### Screenshots of dashboards with live data (all 6+ panels working) + +![](./screenshots/lab08-shots/dashboard1.png) +![](./screenshots/lab08-shots/dashboard2.png) + +### Exported dashboard JSON file + +- you can find the file in ./app_python/monitoring/prometheus/dashboard.json + +## PromQL Examples - 5+ queries with explanations + +### PromQL queries that demonstrate RED method + +### 5+ queries with explanations (red method) + +- `sum(rate(http_requests_total[5m]))` + **rate**: total requests per second, shows overall traffic load + +- `sum(rate(http_requests_total{status_code=~"[45].."}[5m]))` + **errors**: failed requests per second (4xx + 5xx), shows reliability issues + +- `histogram_quantile(0.95, rate(http_request_duration_seconds_bucket[5m]))` + **duration**: p95 latency, shows how slow requests are + +- `sum by (endpoint) (rate(http_requests_total[5m]))` + **rate**: request rate per endpoint, helps see which endpoints are used most + +- `sum by (status_code) (rate(http_requests_total[5m]))` + **errors**: distribution of response codes, helps identify types of failures + +- `http_requests_in_progress` + **rate/load (approx)**: current number of active requests, useful to observe system load + +- `up{job="app"}` + **availability (related to errors)**: shows if service is reachable (1 = up, 0 = down) + +## Production Setup - Health checks, resources, retention policies + +### docker compose ps showing all services healthy + +![](./screenshots/lab08-shots/health%20statuses.png) + +### Documentation of retention policies + +- prometheus is configured to keep metrics for 15 days and up to 10gb of data; this is defined using the retention time and size settings in the docker compose file. this helps to control disk usage and keeps the dataset smaller, which improves query performance. older data is automatically removed once the limits are reached, so the system doesn’t run out of storage. + +### Proof of data persistence after restart + +- if I set 6 hours range I still see my previous data + +![](./screenshots/lab08-shots/persistency.png) + +## Testing Results - Screenshots showing everything working + +- you can see all required screenshots in the above sections + +## Challenges & Solutions - Issues encountered and fixes + +- my app-python container showed unhealty status because in the dockerfile no curl installation happened, I didn't think of it since in the VM it worked fine and I missed that those have different settings, once I added it to the Dockerfile and updated the image, it worked \ No newline at end of file diff --git a/app_python/docs/LAB09.md b/app_python/docs/LAB09.md new file mode 100644 index 0000000000..20ea3e883d --- /dev/null +++ b/app_python/docs/LAB09.md @@ -0,0 +1,301 @@ +# Documentation + +## Architecture Overview + +### Diagram or description of your deployment architecture + +```mermaid +flowchart LR + +subgraph Kubernetes_Cluster["Minikube Kubernetes Cluster"] + + S[Service node port
port 80 -> nodePort 30007] + + subgraph Deployment["Deployment: my-app (5 replicas)"] + P1[Pod 1
app-python] + P2[Pod 2
app-python] + P3[Pod 3
app-python] + P4[Pod 4
app-python] + P5[Pod 5
app-python] + end + +end + +User[User / curl / browser] + +User -->|HTTP request
http://nodeIP:30007| S + +S -->|routes traffic via selector
app: my-app| P1 +S --> P2 +S --> P3 +S --> P4 +S --> P5 + +P1 -->|/health /ready /metrics| AppLogic[(Flask App)] +P2 --> AppLogic +P3 --> AppLogic +P4 --> AppLogic +P5 --> AppLogic + +``` + +### How many Pods, which Services, networking flow + +- I used 5 pods managed by a deployment and one NodePort service, where traffic goes from the service (port 80 / nodePort 30007) to the pods using the app: my-app label selector. + +### Resource allocation strategy + +- I defined small cpu and memory requests/limits (100m–500m cpu, 128Mi–256Mi memory) to keep the app stable and prevent it from using too many cluster resources. + +### Brief explanation of your chosen tool (minikube/kind) and why + +I used minikube because it’s easy to set up locally and lets me run a full kubernetes cluster on my machine, which is enough for testing deployments without needing a real cloud setup. + +## Manifest Files + +### Brief description of each manifest + +- Deployment: deployment.yml defines how my app runs in Kubernetes, including how many pods, which image to use, and how they are configured. + +- Service: service.yml exposes the app inside and outside the cluster by routing traffic to the pods created by the deployment. + +### Key configuration choices + +- Deployment: I set 3 replicas, added resource limits/requests, configured liveness and readiness probes, used labels for selection, and set a rolling update strategy + +- Service: I used NodePort type, matched the selector with app: my-app, set port 80 as the service port, and mapped it to container port 12345 with a fixed nodePort. + +### Why you chose specific values (replicas, resources, etc.) + +- Deployment: I used 3 replicas for basic availability, small cpu/memory values since the app is lightweight, and probes to make sure kubernetes can detect when the app is healthy and ready to serve traffic. + +- Service: I used NodePort so i can access the app locally with minikube, port 80 for convenience, targetPort 12345 to match the app, and a fixed nodePort (30007) to make testing easier. + +## Deployment Evidence + +### Successful cluster setup + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % minikube start + +😄 minikube v1.38.1 on Darwin 26.3 (arm64) +✨ Using the docker driver based on existing profile +👍 Starting "minikube" primary control-plane node in "minikube" cluster +🚜 Pulling base image v0.0.50 ... +🏃 Updating the running docker "minikube" container ... +🐳 Preparing Kubernetes v1.35.1 on Docker 29.2.1 ... +🔎 Verifying Kubernetes components... + ▪ Using image gcr.io/k8s-minikube/storage-provisioner:v5 +🌟 Enabled addons: default-storageclass, storage-provisioner + +❗ /Applications/Docker.app/Contents/Resources/bin/kubectl is version 1.32.2, which may have incompatibilities with Kubernetes 1.35.1. + ▪ Want kubectl v1.35.1? Try 'minikube kubectl -- get pods -A' +🏄 Done! kubectl is now configured to use "minikube" cluster and "default" namespace by default +``` +### Output of kubectl cluster-info and kubectl get nodes + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl cluster-info +Kubernetes control plane is running at https://127.0.0.1:51390 +CoreDNS is running at https://127.0.0.1:51390/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy + +To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'. +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get nodes +NAME STATUS ROLES AGE VERSION +minikube Ready control-plane 6h45m v1.35.1 +``` + +### kubectl get all output + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get all +NAME READY STATUS RESTARTS AGE +pod/my-app-deployment-6f67848dfb-kxbtv 1/1 Running 0 3m11s +pod/my-app-deployment-6f67848dfb-mjq8x 1/1 Running 0 3m11s +pod/my-app-deployment-6f67848dfb-vx95p 1/1 Running 0 3m11s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/kubernetes ClusterIP 10.96.0.1 443/TCP 6h58m + +NAME READY UP-TO-DATE AVAILABLE AGE +deployment.apps/my-app-deployment 3/3 3 3 3m11s + +NAME DESIRED CURRENT READY AGE +replicaset.apps/my-app-deployment-6f67848dfb 3 3 3 3m11s +``` +### kubectl get pods,svc with detailed view + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get pods,svc +NAME READY STATUS RESTARTS AGE +pod/my-app-deployment-6f67848dfb-kxbtv 1/1 Running 0 3m35s +pod/my-app-deployment-6f67848dfb-mjq8x 1/1 Running 0 3m35s +pod/my-app-deployment-6f67848dfb-vx95p 1/1 Running 0 3m35s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/kubernetes ClusterIP 10.96.0.1 443/TCP 6h59m +``` + +### kubectl describe deployment showing replicas and strategy + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get pods +NAME READY STATUS RESTARTS AGE +my-app-deployment-6f67848dfb-kxbtv 1/1 Running 0 29s +my-app-deployment-6f67848dfb-mjq8x 1/1 Running 0 29s +my-app-deployment-6f67848dfb-vx95p 1/1 Running 0 29s +``` +### Screenshot or curl output showing app working + +![](./../docs/screenshots/lab09-shots/curl%20app%20.png) + +### Service deployment + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get services +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +kubernetes ClusterIP 10.96.0.1 443/TCP 38m +my-app-service NodePort 10.98.179.244 80:30007/TCP 41s +(devops) fountainer@Veronicas-MacBook-Air k8s % minikube service my-app-service +┌───────────┬────────────────┬─────────────┬───────────────────────────┐ +│ NAMESPACE │ NAME │ TARGET PORT │ URL │ +├───────────┼────────────────┼─────────────┼───────────────────────────┤ +│ default │ my-app-service │ 80 │ http://192.168.49.2:30007 │ +└───────────┴────────────────┴─────────────┴───────────────────────────┘ +🔗 Starting tunnel for service my-app-service. +┌───────────┬────────────────┬─────────────┬────────────────────────┐ +│ NAMESPACE │ NAME │ TARGET PORT │ URL │ +├───────────┼────────────────┼─────────────┼────────────────────────┤ +│ default │ my-app-service │ │ http://127.0.0.1:57348 │ +└───────────┴────────────────┴─────────────┴────────────────────────┘ +🎉 Opening service default/my-app-service in default browser... +❗ Because you are using a Docker driver on darwin, the terminal needs to be open to run it. +``` +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get services +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +kubernetes ClusterIP 10.96.0.1 443/TCP 42m +my-app-service NodePort 10.98.179.244 80:30007/TCP 4m16s +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl describe service my-app-service +Name: my-app-service +Namespace: default +Labels: +Annotations: +Selector: app=my-app +Type: NodePort +IP Family Policy: SingleStack +IP Families: IPv4 +IP: 10.98.179.244 +IPs: 10.98.179.244 +Port: 80/TCP +TargetPort: 12345/TCP +NodePort: 30007/TCP +Endpoints: 10.244.0.16:12345,10.244.0.14:12345,10.244.0.15:12345 +Session Affinity: None +External Traffic Policy: Cluster +Internal Traffic Policy: Cluster +Events: +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get endpoints +Warning: v1 Endpoints is deprecated in v1.33+; use discovery.k8s.io/v1 EndpointSlice +NAME ENDPOINTS AGE +kubernetes 192.168.49.2:8443 42m +my-app-service 10.244.0.14:12345,10.244.0.15:12345,10.244.0.16:12345 4m36s +(devops) fountainer@Veronicas-MacBook-Air k8s % +``` + +## Operations Performed + +### Commands used to deploy + +- ```bash kubectl apply -f k8s/deployment.yml``` +- ```bash kubectl apply -f k8s/service.yml``` +- ```bash kubectl get pods``` +- ```bash kubectl get services ``` + +### Scaling demonstration output + +![](./../docs/screenshots/lab09-shots/scaling.png) + +### Rolling update demonstration output + +I changed ```bash image: fountainer/my-app:latest``` to ```bash image: fountainer/my-app:2026.03.26```. + +![](./../docs/screenshots/lab09-shots/rollout.png) + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl rollout history deployment/my-app-deployment +deployment.apps/my-app-deployment +REVISION CHANGE-CAUSE +1 +2 +3 + +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl rollout undo deployment/my-app-deployment +deployment.apps/my-app-deployment rolled back +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl rollout status deployment/my-app-deployment +Waiting for deployment "my-app-deployment" rollout to finish: 2 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 2 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 2 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 2 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 3 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 3 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 1 old replicas are pending termination... +Waiting for deployment "my-app-deployment" rollout to finish: 1 old replicas are pending termination... +Waiting for deployment "my-app-deployment" rollout to finish: 1 old replicas are pending termination... +Waiting for deployment "my-app-deployment" rollout to finish: 1 old replicas are pending termination... +Waiting for deployment "my-app-deployment" rollout to finish: 4 of 5 updated replicas are available... +Waiting for deployment "my-app-deployment" rollout to finish: 4 of 5 updated replicas are available... +deployment "my-app-deployment" successfully rolled out +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods +NAME READY STATUS RESTARTS AGE +my-app-deployment-7b5479788b-bj4pt 1/1 Running 0 37s +my-app-deployment-7b5479788b-n2pnb 1/1 Running 0 12s +my-app-deployment-7b5479788b-nvzdr 1/1 Running 0 22s +my-app-deployment-7b5479788b-q9g66 1/1 Running 0 36s +my-app-deployment-7b5479788b-w2nc6 1/1 Running 0 22s +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % +``` + +### Service access method and verification + +I accessed the app using ```bash minikube service my-app-service ``` and verified it by sending requests with curl to endpoints like /health and /ready. + +## Production Considerations + +### What health checks did you implement and why? + +I implemented a liveness probe on /health to restart unhealthy containers and a readiness probe on /ready to ensure pods start receiving traffic only when they are ready to work. + +### Resource limits rationale + +- I set limits to prevent resource overuse, and requests to guarantee the pod gets enough cpu and memory to run reliably. + +### How would you improve this for production? + +- I would add proper logging/monitoring like we did in the previous labs, add autoscaling, consider other update strategies (like canary update). + +### Monitoring and observability strategy + +- In previous labs we used Prometheus for metrics and loki & promtail for logs, also Grafana for dashboard representation + +## Challenges & Solutions + +### Issues encountered + +- I didn't work with NodePort before so I has to stydy it a little bit. Also I didn't know about minikube. + +### How you debugged (logs, describe, events) + +- I researched StackOverflow and other sources, such as documentation for kubernetes and minikube + +### What you learned about Kubernetes + +- I studied kubernetes in the SRE course last semester so I was already pretty familiar with it. We didn't use NodePort service though, and also didn't set up our own cluster since the course team provided us with it. + diff --git a/app_python/docs/LAB10.md b/app_python/docs/LAB10.md new file mode 100644 index 0000000000..e3f80de3ab --- /dev/null +++ b/app_python/docs/LAB10.md @@ -0,0 +1,499 @@ +# Documentation + +## Chart Overview + +### Chart structure explanation + +- the chart has templates/ for kubectl manifests, values.yaml for default settings, and _helpers.tpl for reusable template functions. Hooks are in templates/hooks/ for pre and post-install jobs + +### Key template files and their purpose + +- deployment.yaml defines the app pods and containers +- service.yaml exposes them, and hooks run tasks before or after install +- helpers in _helpers.tpl build names, labels, and selectors consistently, and then can be reused in different config files + +### Values organization strategy + +- values.yaml has defaults, while values-dev.yaml and values-prod.yaml override settings for different environments. +This keeps environment configs separate and easy to manage. + +## Configuration Guide + +### Important values and their purpose + +- replicaCount sets pod number, resources manage CPU/memory, service.type controls what role will the service have (NodePort vs LoadBalancer, etc). LivenessProbe and readinessProbe check pod health. + +### How to customize for different environments + +- you can use values-dev.yaml for dev with 1 replica and NodePort, values-prod.yaml for prod with more replicas and LoadBalancer. and you can also override values on install with --set + +### Example installations with different configurations + +- dev + +```bash +helm install myapp-dev k8s/app_python -f k8s/app_python/values-dev.yaml +``` + +- prod + +```bash +helm install myapp-prod k8s/app_python -f k8s/app_python/values-prod.yaml +``` + +## Hook Implementation + +### What hooks you implemented and why + +- I implemented a pre-install job for setup tasks and a post-install job for validation, to simulate real lifecycle tasks + +### Hook execution order and weights + +- Pre-install has weight -5 to run early, post-install has weight 5 to run after deployment. + +### Deletion policies explanation + +- both hooks have hook-succeeded policy so they auto-delete after finishing successfully + +## Installation Evidence + +### Terminal output showing Helm installation and version (should be 4.x) + +```bash +==> Fetching downloads for: helm +✔︎ Bottle Manifest helm (4.1.3) Downloaded 7.4KB/ 7.4KB +✔︎ Bottle helm (4.1.3) Downloaded 18.1MB/ 18.1MB +==> Pouring helm--4.1.3.arm64_tahoe.bottle.tar.gz +🍺 /opt/homebrew/Cellar/helm/4.1.3: 69 files, 61.3MB +==> Running `brew cleanup helm`... +Disable this behaviour by setting `HOMEBREW_NO_INSTALL_CLEANUP=1`. +Hide these hints with `HOMEBREW_NO_ENV_HINTS=1` (see `man brew`). +==> Caveats +zsh completions have been installed to: + /opt/homebrew/share/zsh/site-functions +``` +### Output of exploring a public chart (e.g., helm show chart prometheus-community/prometheus) + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm show chart prometheus-community/prometheus +annotations: + artifacthub.io/license: Apache-2.0 + artifacthub.io/links: | + - name: Chart Source + url: https://github.com/prometheus-community/helm-charts + - name: Upstream Project + url: https://github.com/prometheus/prometheus +apiVersion: v2 +appVersion: v3.11.0 +dependencies: +- condition: alertmanager.enabled + name: alertmanager + repository: https://prometheus-community.github.io/helm-charts + version: 1.34.* +- condition: kube-state-metrics.enabled + name: kube-state-metrics + repository: https://prometheus-community.github.io/helm-charts + version: 7.2.* +- condition: prometheus-node-exporter.enabled + name: prometheus-node-exporter + repository: https://prometheus-community.github.io/helm-charts + version: 4.52.* +- condition: prometheus-pushgateway.enabled + name: prometheus-pushgateway + repository: https://prometheus-community.github.io/helm-charts + version: 3.6.* +description: Prometheus is a monitoring system and time series database. +home: https://prometheus.io/ +icon: https://raw.githubusercontent.com/prometheus/prometheus.github.io/master/assets/prometheus_logo-cb55bb5c346.png +keywords: +- monitoring +- prometheus +kubeVersion: '>=1.19.0-0' +maintainers: +- email: gianrubio@gmail.com + name: gianrubio + url: https://github.com/gianrubio +- email: zanhsieh@gmail.com + name: zanhsieh + url: https://github.com/zanhsieh +- email: miroslav.hadzhiev@gmail.com + name: Xtigyro + url: https://github.com/Xtigyro +- email: naseem@transit.app + name: naseemkullah + url: https://github.com/naseemkullah +- email: rootsandtrees@posteo.de + name: zeritti + url: https://github.com/zeritti +name: prometheus +sources: +- https://github.com/prometheus/alertmanager +- https://github.com/prometheus/prometheus +- https://github.com/prometheus/pushgateway +- https://github.com/prometheus/node_exporter +- https://github.com/kubernetes/kube-state-metrics +type: application +version: 28.15.0 +``` + +### helm list output + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % helm list +NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION +my-python-app-dev default 1 2026-04-02 22:00:55.999506 +0300 MSK deployed app_python-0.1.0 1.0 +my-python-app-prod default 1 2026-04-02 22:12:24.157572 +0300 MSK deployed app_python-0.1.0 1.0 +myrelease default 1 2026-04-02 22:40:56.562009 +0300 MSK deployed app_python-0.1.0 1.0 +``` + +### kubectl get all showing deployed resources + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get all +NAME READY STATUS RESTARTS AGE +pod/my-python-app-dev-app-python-7d7f699d85-kklth 1/1 Running 0 43m +pod/my-python-app-prod-app-python-74c5b97dd5-4mjjr 0/1 Running 0 31m +pod/my-python-app-prod-app-python-74c5b97dd5-6pm7l 0/1 Running 0 31m +pod/my-python-app-prod-app-python-74c5b97dd5-75dvc 0/1 Running 0 31m +pod/my-python-app-prod-app-python-74c5b97dd5-9v58s 0/1 Running 0 31m +pod/my-python-app-prod-app-python-74c5b97dd5-xktsb 0/1 Running 0 31m +pod/myrelease-app-python-569fb4b645-6v9dt 1/1 Running 0 2m32s +pod/myrelease-app-python-569fb4b645-8ws5n 1/1 Running 0 2m32s +pod/myrelease-app-python-569fb4b645-glt5r 1/1 Running 0 2m32s +pod/myrelease-app-python-569fb4b645-qtg4j 1/1 Running 0 2m32s +pod/myrelease-app-python-569fb4b645-rgppk 1/1 Running 0 2m32s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/kubernetes ClusterIP 10.96.0.1 443/TCP 8d +service/my-python-app-dev-app-python-service NodePort 10.104.238.26 80:30007/TCP 43m +service/my-python-app-prod-app-python-service LoadBalancer 10.101.156.227 80:30008/TCP 31m +service/myrelease-app-python-service NodePort 10.107.17.3 80:30009/TCP 2m32s + +NAME READY UP-TO-DATE AVAILABLE AGE +deployment.apps/my-python-app-dev-app-python 1/1 1 1 43m +deployment.apps/my-python-app-prod-app-python 0/5 5 0 31m +deployment.apps/myrelease-app-python 5/5 5 5 2m32s + +NAME DESIRED CURRENT READY AGE +replicaset.apps/my-python-app-dev-app-python-7d7f699d85 1 1 1 43m +replicaset.apps/my-python-app-prod-app-python-74c5b97dd5 5 5 0 31m +replicaset.apps/myrelease-app-python-569fb4b645 5 5 5 2m32s +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % +``` + +### Hook execution output (kubectl get jobs) + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get jobs -w +NAME STATUS COMPLETIONS DURATION AGE +myrelease-app-python-pre-install Running 0/1 0s +myrelease-app-python-pre-install Running 0/1 0s 0s +myrelease-app-python-pre-install Running 0/1 33s 33s +myrelease-app-python-pre-install Running 0/1 43s 43s +myrelease-app-python-pre-install SuccessCriteriaMet 0/1 44s 44s +myrelease-app-python-pre-install Complete 1/1 44s 44s +myrelease-app-python-pre-install Complete 1/1 44s 44s +myrelease-app-python-post-install Running 0/1 0s +myrelease-app-python-post-install Running 0/1 0s 0s +myrelease-app-python-post-install Running 0/1 5s 5s +myrelease-app-python-post-install Running 0/1 15s 15s +myrelease-app-python-post-install SuccessCriteriaMet 0/1 16s 16s +myrelease-app-python-post-install Complete 1/1 16s 16s +myrelease-app-python-post-install Complete 1/1 16s 16s +``` + +### Different environment deployments (dev vs prod) + +- Dev + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm install my-python-app-dev k8s/app_python -f k8s/app_python/values-dev.yaml +NAME: my-python-app-dev +LAST DEPLOYED: Thu Apr 2 22:00:55 2026 +NAMESPACE: default +STATUS: deployed +REVISION: 1 +DESCRIPTION: Install complete +TEST SUITE: None +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pods +NAME READY STATUS RESTARTS AGE +my-python-app-dev-app-python-7d7f699d85-kklth 1/1 Running 0 2m20s +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get svc +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +kubernetes ClusterIP 10.96.0.1 443/TCP 7d23h +my-python-app-dev-app-python-service NodePort 10.104.238.26 80:30007/TCP 2m27s +``` + +- Prod + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm install my-python-app-prod k8s/app_python -f k8s/app_python/values-prod.yaml +NAME: my-python-app-prod +LAST DEPLOYED: Thu Apr 2 22:12:24 2026 +NAMESPACE: default +STATUS: deployed +REVISION: 1 +DESCRIPTION: Install complete +TEST SUITE: None +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pod +NAME READY STATUS RESTARTS AGE +my-python-app-dev-app-python-7d7f699d85-kklth 1/1 Running 0 12m +my-python-app-prod-app-python-74c5b97dd5-4mjjr 0/1 Running 0 38s +my-python-app-prod-app-python-74c5b97dd5-6pm7l 0/1 Running 0 38s +my-python-app-prod-app-python-74c5b97dd5-75dvc 0/1 Running 0 38s +my-python-app-prod-app-python-74c5b97dd5-9v58s 0/1 Running 0 38s +my-python-app-prod-app-python-74c5b97dd5-xktsb 0/1 Running 0 38s +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get svc +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +kubernetes ClusterIP 10.96.0.1 443/TCP 7d23h +my-python-app-dev-app-python-service NodePort 10.104.238.26 80:30007/TCP 12m +my-python-app-prod-app-python-service LoadBalancer 10.101.156.227 80:30008/TCP 49s +``` + + +## Operations + +### Installation commands used + +```bash +helm install name-of-new-release k8s/app_python -f k8s/app_python/values-for-new-release.yaml +``` +### How to upgrade a release + +```bash +helm upgrade myrelease k8s/app_python -f k8s/app_python/values-prod.yaml +``` + +### How to rollback + +```bash +helm rollback myrelease 1 +``` + +### How to uninstall + +```bash +helm uninstall name-of-release +``` + +## Testing & Validation + +### helm lint output + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % helm lint app_python +==> Linting app_python +[INFO] Chart.yaml: icon is recommended + +1 chart(s) linted, 0 chart(s) failed +``` +### helm template verification + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm template app-python k8s/app_python +--- +# Source: app_python/templates/service.yaml +apiVersion: v1 +kind: Service +metadata: + name: app-python-app-python-service +spec: + type: NodePort + selector: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: app-python + ports: + - protocol: TCP + port: 80 + targetPort: 12345 + nodePort: 30007 +--- +# Source: app_python/templates/deployment.yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: app-python-app-python + labels: + helm.sh/chart: app_python-0.1.0 + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: app-python + app.kubernetes.io/version: "1.0" + app.kubernetes.io/managed-by: Helm +spec: + replicas: 5 + strategy: + type: RollingUpdate + rollingUpdate: + maxUnavailable: 1 + maxSurge: 1 + selector: + matchLabels: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: app-python + template: + metadata: + labels: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: app-python + spec: + containers: + - name: app-python + image: "fountainer/my-app:2026.03.26" + imagePullPolicy: IfNotPresent + ports: + - containerPort: 12345 + resources: + requests: + cpu: 100m + memory: 128Mi + limits: + cpu: 500m + memory: 256Mi + livenessProbe: + httpGet: + path: /health + port: 12345 + initialDelaySeconds: 10 + periodSeconds: 10 + timeoutSeconds: 5 + failureThreshold: 5 + readinessProbe: + httpGet: + path: /ready + port: 12345 + initialDelaySeconds: 5 + periodSeconds: 5 +``` + +### Dry-run output + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm install --dry-run --debug test-release k8s/app_python +level=WARN msg="--dry-run is deprecated and should be replaced with '--dry-run=client'" +level=DEBUG msg="Original chart version" version="" +level=DEBUG msg="Chart path" path=/Users/fountainer/uni/devops/DevOps-Core-Course/app_python/k8s/app_python +level=DEBUG msg="number of dependencies in the chart" chart=app_python dependencies=0 +NAME: test-release +LAST DEPLOYED: Thu Apr 2 21:46:17 2026 +NAMESPACE: default +STATUS: pending-install +REVISION: 1 +DESCRIPTION: Dry run complete +TEST SUITE: None +USER-SUPPLIED VALUES: +{} + +COMPUTED VALUES: +container: + port: 12345 +image: + pullPolicy: IfNotPresent + repository: fountainer/my-app + tag: 2026.03.26 +livenessProbe: + failureThreshold: 5 + initialDelaySeconds: 10 + path: /health + periodSeconds: 10 + timeoutSeconds: 5 +readinessProbe: + initialDelaySeconds: 5 + path: /ready + periodSeconds: 5 +replicaCount: 5 +resources: + limits: + cpu: 500m + memory: 256Mi + requests: + cpu: 100m + memory: 128Mi +service: + nodePort: 30007 + port: 80 + protocol: TCP + targetPort: 12345 + type: NodePort +strategy: + maxSurge: 1 + maxUnavailable: 1 + +HOOKS: +MANIFEST: +--- +# Source: app_python/templates/service.yaml +apiVersion: v1 +kind: Service +metadata: + name: test-release-app-python-service +spec: + type: NodePort + selector: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: test-release + ports: + - protocol: TCP + port: 80 + targetPort: 12345 + nodePort: 30007 +--- +# Source: app_python/templates/deployment.yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: test-release-app-python + labels: + helm.sh/chart: app_python-0.1.0 + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: test-release + app.kubernetes.io/version: "1.0" + app.kubernetes.io/managed-by: Helm +spec: + replicas: 5 + strategy: + type: RollingUpdate + rollingUpdate: + maxUnavailable: 1 + maxSurge: 1 + selector: + matchLabels: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: test-release + template: + metadata: + labels: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: test-release + spec: + containers: + - name: app-python + image: "fountainer/my-app:2026.03.26" + imagePullPolicy: IfNotPresent + ports: + - containerPort: 12345 + resources: + requests: + cpu: 100m + memory: 128Mi + limits: + cpu: 500m + memory: 256Mi + livenessProbe: + httpGet: + path: /health + port: 12345 + initialDelaySeconds: 10 + periodSeconds: 10 + timeoutSeconds: 5 + failureThreshold: 5 + readinessProbe: + httpGet: + path: /ready + port: 12345 + initialDelaySeconds: 5 + periodSeconds: 5 + +``` +### Application accessibility verification + +![](./../docs/screenshots/lab10-shots/app-working.png) \ No newline at end of file diff --git a/app_python/docs/LAB11.md b/app_python/docs/LAB11.md new file mode 100644 index 0000000000..1c62eae2de --- /dev/null +++ b/app_python/docs/LAB11.md @@ -0,0 +1,197 @@ +# Documentation + +## Kubernetes Secrets + +### Output of creating and viewing your secret + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl create secret generic app-credentials --from-literal=username=fountainer --from-literal=password=‘mypass293i20@@nekf’ +secret/app-credentials created +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get secret app-credentials -o yaml +apiVersion: v1 +data: + password: 4oCYbXlwYXNzMjkzaTIwQEBuZWtm4oCZ + username: Zm91bnRhaW5lcg== +kind: Secret +metadata: + creationTimestamp: "2026-04-07T14:46:16Z" + name: app-credentials + namespace: default + resourceVersion: "24859" + uid: 6997ca85-68fa-4278-9d51-a6531df977e9 +type: Opaque +``` +### Decoded secret values demonstration + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % echo "4oCYbXlwYXNzMjkzaTIwQEBuZWtm4oCZ" | base64 -d +‘mypass293i20@@nekf’% +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % echo "Zm91bnRhaW5lcg==" | base64 -d +fountainer% +``` +### Explanation of base64 encoding vs encryption + +- Encoding is when we use some publicly accesible algorithm to encode our data. The goal is keeping integrity and usability of the data, it is not really about security. + +- In turn, Encryption is about securuty. It envolves encrypting with an algorithm that can be only resolved by a user who has an encryption key. + +## Helm Secret Integration + +### Chart structure showing secrets.yaml + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % tree app_python/k8s/app_python +app_python/k8s/app_python +├── Chart.yaml +├── charts +├── templates +│ ├── _helpers.tpl +│ ├── deployment.yaml +│ ├── hooks +│ │ ├── post-install-job.yaml +│ │ └── pre-install-job.yaml +│ ├── secrets.yaml +│ └── service.yaml +├── values-dev.yaml +├── values-prod.yaml +└── values.yaml +``` + +### How secrets are consumed in deployment + +- I have $secretName variable that is dynamically set to the name from the values.yaml and values I provide in the helm install command OR defaults to the value from helper. + +### Verification output (env vars in pod, excluding actual values) + +- in pod I have correct env vars: + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl exec -it mysecretrelease-app-python-7975557578-6zc9m -- sh +$ echo $PASSWORD +mypass293i20@@nekf +$ echo $USERNAME +fountainer +``` + +- and outside the secrets are hidden + +from ```bash kubectl describe pod mysecretrelease-app-python-7975557578-6zc9m``` + +```bash +Environment: + PASSWORD: Optional: false + USERNAME: Optional: false +``` + + +## Resource Management + +### Resource limits configuration + +```bash +resources: + requests: + cpu: {{ .Values.resources.requests.cpu }} + memory: {{ .Values.resources.requests.memory }} + limits: + cpu: {{ .Values.resources.limits.cpu }} + memory: {{ .Values.resources.limits.memory }} +``` +- in values.yaml I have + +```bash +resources: + requests: + cpu: "100m" + memory: "128Mi" + limits: + cpu: "500m" + memory: "256Mi" +``` + +### Explanation of requests vs limits + +- requests is a setting that shows kubernates how much resources are needed for a container to run +- limits show how much resources a container is allowed to use (max) + +### How to choose appropriate values + +- you should analyze what processes does your container run and how many cpu/memory it may need +- values can be adjusted by observing the running container +- if you have multiple containers/pods you should constraint them in such a way that they all can work without throttling +- if the memory limit is too low the container can be killed right away + +## Vault Integration + +### Vault installation verification (kubectl get pods) + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pod +NAME READY STATUS RESTARTS AGE +mysecretrelease-app-python-7975557578-6zc9m 1/1 Running 0 63m +mysecretrelease-app-python-7975557578-7l4tv 1/1 Running 0 63m +mysecretrelease-app-python-7975557578-bqnpd 1/1 Running 0 63m +mysecretrelease-app-python-7975557578-cjjcb 1/1 Running 0 63m +mysecretrelease-app-python-7975557578-st2jd 1/1 Running 0 63m +vault-0 1/1 Running 0 8m23s +vault-agent-injector-848dd747d7-qvgl2 1/1 Running 0 8m23s +``` + +### Policy and role configuration (sanitized) + +- policy + +```bash +/ $ vault policy write myapp-policy /tmp/myapp-policy.hcl +Success! Uploaded policy: myapp-policy +/ $ vault policy read myapp-policy +path "secret/data/myapp/config" { + capabilities = ["read"] +} +``` + +- role config + +```bash +vault write auth/kubernetes/role/myapp-role \ + bound_service_account_names=default \ + bound_service_account_namespaces=default \ + policies=myapp-policy \ + ttl=48h +``` + + +### Proof of secret injection (show file exists, path structure) + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl exec -it mysecretrelease-app-python-558b98bb9d-8299m -- /bin/sh +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +$ ls -l /vault/secrets +total 4 +-rw-r--r-- 1 100 newuser 180 Apr 7 23:55 config +$ cat /vault/secrets/config +data: map[password:mypass293i20@@nekf username:fountainer] +metadata: map[created_time:2026-04-07T23:32:33.85543147Z custom_metadata: deletion_time: destroyed:false version:1] +$ +``` + +### Explanation of the sidecar injection pattern + +- now every pod contains not only my app container but also vault sidecar container +- vault is able to authenticate in kubernates and inject secrets into the pod + +## Security Analysis + +### Comparison: K8s Secrets vs Vault + +- kubernates secrets are just encoded into base 64 and everyone who gets access to the cluster can decode them and get sensitive data, on the other hand, vault provides data encryption that is much more safer since you need an encryption key to encrypt it + +### When to use each approach + +- encoding is good for keeping data usability and integrity, so different machines can use it (like for seeing special symbols on a web page), it is like... more secure than nothing, but not reeally secure + +- vault encryption is needed for keeping sensitive data secure, like for storing passwords for the services on the virtual machines, etc + +### Production recommendations + +- in production you should always try to use strong encryption algorithms to keep your data secure diff --git a/app_python/docs/LAB12.md b/app_python/docs/LAB12.md new file mode 100644 index 0000000000..f79a158422 --- /dev/null +++ b/app_python/docs/LAB12.md @@ -0,0 +1,141 @@ +# Documentation + +## Application Changes + +### Description of visits counter implementation + +visits counter is a global integer that increases every time / endpoint is called. it writes the value into a file (visits) so it can survive pod restarts via pvc. + +### New endpoint documentation + +/visits returns the current stored counter value from data/visits file + +### Local testing evidence with Docker + +Here you can see the counter value persistence across restarts. +![](./../docs/screenshots/lab12-shots/counter.png) + +## ConfigMap Implementation + +### ConfigMap template structure + +Helm ConfigMap loads a local config.json file via .Files.Get, so the whole json is injected into the cluster as one config object + +### config.json content + +it contains basic app metadata like name, environment, and feature flags (debug, metrics) plus log level settings + +### How ConfigMap is mounted as file + +the ConfigMap is mounted as a volume at /config, so inside the container we can read /config/config.json as a normal file. + +### How ConfigMap provides environment variables + +by using envFrom: configMapRef to inject keys like APP_NAME, APP_ENV, and LOG_LEVEL directly as environment variables. + + +### Verification outputs + +- File content inside pod (cat /config/config.json) + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec mysecretrelease-app-python-696f97599c-5llgh -- cat /config/config.json +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +{ + "app_name": "my-app", + "environment": "dev", + "feature_flags": { + "debug": true, + "metrics": true + }, + "settings": { + "log_level": "info" + } +}% +``` + +- Environment variables in pod + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec mysecretrelease-app-python-696f97599c-5llgh -- printenv | grep APP_ +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +APP_ENV=dev +APP_NAME=my-app +MYSECRETRELEASE_APP_PYTHON_SERVICE_SERVICE_PORT=80 +MYSECRETRELEASE_APP_PYTHON_SERVICE_PORT_80_TCP=tcp://10.103.123.105:80 +MYSECRETRELEASE_APP_PYTHON_SERVICE_PORT_80_TCP_PROTO=tcp +MYSECRETRELEASE_APP_PYTHON_SERVICE_PORT_80_TCP_PORT=80 +MYSECRETRELEASE_APP_PYTHON_SERVICE_SERVICE_HOST=10.103.123.105 +MYSECRETRELEASE_APP_PYTHON_SERVICE_PORT=tcp://10.103.123.105:80 +MYSECRETRELEASE_APP_PYTHON_SERVICE_PORT_80_TCP_ADDR=10.103.123.105 +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec mysecretrelease-app-python-696f97599c-5llgh -- printenv | grep LOG_LEVEL +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +LOG_LEVEL=info +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` + + +## Persistent Volume + +### PVC configuration explanation + +PVC requests a small storage size (100Mi) and creates a persistent volume that is mounted into the pod at /app/data to store the visits file. + +### Access modes and storage class discussion + +ReadWriteOnce is used because only one pod needs to write to the volume, and storageClass is optional so it uses the cluster default. + +### Volume mount configuration + +the volume is mounted into the container at /app/data, and the app writes visits file there so data stays after pod restarts/recreations + +### Persistence test evidence: + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec mysecretrelease-app-python-7b6579656c-z6r7b -- cat /app/data/visits +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +22% +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl delete pod mysecretrelease-app-python-7b6579656c-z6r7b +pod "mysecretrelease-app-python-7b6579656c-z6r7b" deleted +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pod +NAME READY STATUS RESTARTS AGE +mysecretrelease-app-python-7b6579656c-b2tzf 2/2 Running 0 60s +vault-0 1/1 Running 3 (84m ago) 8d +vault-agent-injector-848dd747d7-qvgl2 1/1 Running 3 (85m ago) 8d +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec mysecretrelease-app-python-7b6579656c-b2tzf -- cat /app/data/visits +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +22% +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` + +## ConfigMap vs Secret + +### When to use ConfigMap + +ConfigMap is used for non-sensitive configuration like app name, environment, log level, and feature flags. + +### When to use Secret + +secret is used for sensitive data like username, password, or anything that should not be visible in plain text + +### Key differences + +configMap is plain text and not encrypted, while Secret is base64 encoded and used for sensitive data. + +## Additional Outputs: + +### kubectl get configmap,pvc output + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get configmap,pvc +NAME DATA AGE +configmap/kube-root-ca.crt 1 22d +configmap/mysecretrelease-app-python-config 1 7m2s +configmap/mysecretrelease-app-python-env 3 7m2s + +NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS VOLUMEATTRIBUTESCLASS AGE +persistentvolumeclaim/mysecretrelease-app-python-data Bound pvc-42d4685f-8463-4434-8959-0bacd5d972b6 100Mi RWO standard 7m2s +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` + + diff --git a/app_python/docs/LAB13.md b/app_python/docs/LAB13.md new file mode 100644 index 0000000000..67c2551dda --- /dev/null +++ b/app_python/docs/LAB13.md @@ -0,0 +1,214 @@ +# Documentation + +## ArgoCD Setup + +### Installation verification + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm install argocd argo/argo-cd --namespace argocd +NAME: argocd +LAST DEPLOYED: Thu Apr 23 18:37:11 2026 +NAMESPACE: argocd +STATUS: deployed +REVISION: 1 +DESCRIPTION: Install complete +TEST SUITE: None +NOTES: +In order to access the server UI you have the following options: + +1. kubectl port-forward service/argocd-server -n argocd 8080:443 + + and then open the browser on http://localhost:8080 and accept the certificate + +2. enable ingress in the values file `server.ingress.enabled` and either + - Add the annotation for ssl passthrough: https://argo-cd.readthedocs.io/en/stable/operator-manual/ingress/#option-1-ssl-passthrough + - Set the `configs.params."server.insecure"` in the values file and terminate SSL at your ingress: https://argo-cd.readthedocs.io/en/stable/operator-manual/ingress/#option-2-multiple-ingress-objects-and-hosts + + +After reaching the UI the first time you can login with username: admin and the random password generated during the installation. You can find the password by running: + +kubectl -n argocd get secret argocd-initial-admin-secret -o jsonpath="{.data.password}" | base64 -d + +(You should delete the initial secret afterwards as suggested by the Getting Started Guide: https://argo-cd.readthedocs.io/en/stable/getting_started/#4-login-using-the-cli) +(devops) fountainer@Veronicas-MacBook-Air app_python % helm list -n argocd +NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION +argocd argocd 1 2026-04-23 18:37:11.582773 +0300 MSK deployed argo-cd-9.5.4 v3.3.8 +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % argocd version +argocd: v3.3.8+7ae7d2c.dirty + BuildDate: 2026-04-21T20:19:34Z + GitCommit: 7ae7d2cc723f5408b080a31263e705198af08613 + GitTreeState: dirty + GitTag: v3.3.8 + GoVersion: go1.26.2 + Compiler: gc + Platform: darwin/arm64 +argocd-server: v3.3.8 + BuildDate: 2026-04-21T17:19:47Z + GitCommit: 7ae7d2cc723f5408b080a31263e705198af08613 + GitTreeState: clean + GitTag: v3.3.8 + GoVersion: go1.25.5 + Compiler: gc + Platform: linux/arm64 + Kustomize Version: v5.8.1 2026-02-09T16:15:27Z + Helm Version: v3.19.4+g7cfb6e4 + Kubectl Version: v0.34.0 + Jsonnet Version: v0.21.0 + ``` + +### UI access method + +Accessed ArgoCD UI via kubectl port-forward to localhost and logged in through the browser using the admin credentials and a previously created password. + +### CLI configuration + +Installed the argocd CLI with Homebrew and connected to the server using argocd login localhost:8080 --insecure. + +## Application Configuration + +### Application manifests + +Created an ArgoCD Application manifest defining the app name, project, source repository, and destination cluster settings. + +### Source and destination configuration + +Configured the application to pull from the Git repository (Helm chart path) and deploy to the in-cluster Kubernetes API in the default namespace. + +### Values file selection + +Specified values.yaml as the Helm values file to control application configuration during deployment. To test, I changed the number of replicas from 1 to 3. + +## Multi-Environment + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n dev +NAME READY STATUS RESTARTS AGE +python-app-dev-app-python-59fdf484d5-g97xn 1/1 Running 1 (22m ago) 22m +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n prod +NAME READY STATUS RESTARTS AGE +python-app-prod-app-python-9dc9c6fbc-n8mtr 1/1 Running 0 4m14s +python-app-prod-app-python-9dc9c6fbc-sqflv 1/1 Running 0 21m +python-app-prod-app-python-9dc9c6fbc-xfvbj 1/1 Running 0 4m14s +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % argocd app list +NAME CLUSTER NAMESPACE PROJECT STATUS HEALTH SYNCPOLICY CONDITIONS REPO PATH TARGET +argocd/my-app https://kubernetes.default.svc default default Synced Healthy Manual https://github.com/ffountainer/DevOps-Core-Course app_python/k8s/app_python lab13 +argocd/python-app-dev https://kubernetes.default.svc dev default Synced Healthy Auto-Prune https://github.com/ffountainer/DevOps-Core-Course app_python/k8s/app_python lab13 +argocd/python-app-prod https://kubernetes.default.svc prod default Synced Healthy Manual https://github.com/ffountainer/DevOps-Core-Course app_python/k8s/app_python lab13 +``` + +### Dev vs Prod configuration differences + +Dev uses smaller resource limits and fewer replicas for faster iteration, while prod uses higher replica count and stricter resource limits for stability and performance. + +### Sync policy differences and rationale + +Dev is configured with automated sync including self-heal and prune for continuous deployment, while prod uses manual sync to ensure controlled and reviewed releases. + +### Namespace separation + +Dev and prod are deployed into separate namespaces to isolate environments, prevent interference, and ensure independent lifecycle management. + +## Self-Healing Evidence + +### Manual scale test with before/after + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get deploy -n dev +NAME READY UP-TO-DATE AVAILABLE AGE +python-app-dev-app-python 1/1 1 1 30m +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl scale deployment python-app-dev-app-python -n dev --replicas=5 +deployment.apps/python-app-dev-app-python scaled +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get deploy -n dev +NAME READY UP-TO-DATE AVAILABLE AGE +python-app-dev-app-python 1/1 1 1 31m +``` + +### Pod deletion test + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n dev +NAME READY STATUS RESTARTS AGE +python-app-dev-app-python-59fdf484d5-g97xn 1/1 Running 1 (31m ago) 32m +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl delete pod python-app-dev-app-python-59fdf484d5-g97xn -n dev +pod "python-app-dev-app-python-59fdf484d5-g97xn" deleted +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n dev +NAME READY STATUS RESTARTS AGE +python-app-dev-app-python-59fdf484d5-249xv 0/1 Running 0 15s +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n dev +NAME READY STATUS RESTARTS AGE +python-app-dev-app-python-59fdf484d5-249xv 1/1 Running 0 37s +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % +``` + +### Configuration drift test + +Here you can see the drift +![](./../docs/screenshots/lab13-shots/drift.png) + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % argocd app get python-app-dev +Name: argocd/python-app-dev +Project: default +Server: https://kubernetes.default.svc +Namespace: dev +URL: https://argocd.example.com/applications/python-app-dev +Source: +- Repo: https://github.com/ffountainer/DevOps-Core-Course + Target: lab13 + Path: app_python/k8s/app_python + Helm Values: values-dev.yaml +SyncWindow: Sync Allowed +Sync Policy: Automated (Prune) +Sync Status: Synced to lab13 (27593a9) +Health Status: Healthy + +GROUP KIND NAMESPACE NAME STATUS HEALTH HOOK MESSAGE +batch Job dev python-app-dev-app-python-pre-install Succeeded PreSync Reached expected number of succeeded pods + Secret dev app-credentials Synced secret/app-credentials configured + ConfigMap dev python-app-dev-app-python-env Synced configmap/python-app-dev-app-python-env unchanged + ConfigMap dev python-app-dev-app-python-config Synced configmap/python-app-dev-app-python-config unchanged + PersistentVolumeClaim dev python-app-dev-app-python-data Synced Healthy persistentvolumeclaim/python-app-dev-app-python-data unchanged + Service dev python-app-dev-app-python-service Synced Healthy service/python-app-dev-app-python-service unchanged +apps Deployment dev python-app-dev-app-python Synced Healthy deployment.apps/python-app-dev-app-python configured +batch Job dev python-app-dev-app-python-post-install Succeeded PostSync Reached expected number of succeeded pods +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl scale deployment python-app-dev-app-python -n dev --replicas=2 +deployment.apps/python-app-dev-app-python scaled +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get deploy -n dev +NAME READY UP-TO-DATE AVAILABLE AGE +python-app-dev-app-python 1/1 1 1 52m +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl describe deployment python-app-dev-app-python -n dev | grep Replicas +Replicas: 1 desired | 1 updated | 1 total | 1 available | 0 unavailable + Available True MinimumReplicasAvailable +``` + +### Explanation of behaviors + +- Explain when ArgoCD syncs vs when Kubernetes heals + +ArgoCD references changes in git, and Kubernetes monitors the cluster (it will heal if the pod crushes, etc) + +- What triggers ArgoCD sync? + +git repo changes, manual sync triggered, auto-sync enabled, drift detected + self-heal enabled + +- What is the sync interval? + +the default sync is every 3 minutes + +## Screenshots + +### ArgoCD UI showing the applications + +![](./../docs/screenshots/lab13-shots/application.png) + +### Sync status + +![](./../docs/screenshots/lab13-shots/sync%20status.png) +![](./../docs/screenshots/lab13-shots/sync.png) + +### Application details view + +![](./../docs/screenshots/lab13-shots/details.png) \ No newline at end of file diff --git a/app_python/docs/LAB14.md b/app_python/docs/LAB14.md new file mode 100644 index 0000000000..7a37244b4c --- /dev/null +++ b/app_python/docs/LAB14.md @@ -0,0 +1,252 @@ +# Documentation + +## Argo Rollouts Setup + +### Installation verification + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl apply -n argo-rollouts -f https://github.com/argoproj/argo-rollouts/releases/latest/download/install.yaml +customresourcedefinition.apiextensions.k8s.io/analysisruns.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/analysistemplates.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/clusteranalysistemplates.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/experiments.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/rollouts.argoproj.io created +serviceaccount/argo-rollouts created +clusterrole.rbac.authorization.k8s.io/argo-rollouts created +clusterrole.rbac.authorization.k8s.io/argo-rollouts-aggregate-to-admin created +clusterrole.rbac.authorization.k8s.io/argo-rollouts-aggregate-to-edit created +clusterrole.rbac.authorization.k8s.io/argo-rollouts-aggregate-to-view created +clusterrolebinding.rbac.authorization.k8s.io/argo-rollouts created +configmap/argo-rollouts-config created +secret/argo-rollouts-notification-secret created +service/argo-rollouts-metrics created +deployment.apps/argo-rollouts created +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n argo-rollouts +NAME READY STATUS RESTARTS AGE +argo-rollouts-5f64f8d68-zxx5z 1/1 Running 0 54s +``` +```bash +==> Fetching downloads for: kubectl-argo-rollouts +✔︎ Formula kubectl-argo-rollouts (v1.8.3) Verified 130.1MB/130.1MB +==> Installing kubectl-argo-rollouts from argoproj/tap +``` + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl argo rollouts version +kubectl-argo-rollouts: v1.8.3+49fa151 + BuildDate: 2025-06-04T22:19:21Z + GitCommit: 49fa1516cf71672b69e265267da4e1d16e1fe114 + GitTreeState: clean + GoVersion: go1.23.9 + Compiler: gc + Platform: darwin/amd64 +``` + +### Dashboard access + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n argo-rollouts +NAME READY STATUS RESTARTS AGE +argo-rollouts-5f64f8d68-zxx5z 1/1 Running 0 12m +argo-rollouts-dashboard-755bbc64c-pnkl6 1/1 Running 0 28s +``` + +![](./../docs/screenshots/lab14-shots/argo-dashboard-access.png) + +### Understand Rollout vs Deployment + +Rollout CRD vs Deployment + +- Rollout and Deployment are kinda similar and both have replicas, selector, template, strategy fields, they manage pod creation. But rollout has additional fields for strategy that allow to perform more controllable rollouts with specific configurations, like rolling an update for a group of users, not for all. + +Additional fields for progressive delivery + +- canary: allows gradual traffic shifting to a new version using steps (e.g., setWeight, pause) +- blueGreen: supports switching between old and new versions using separate services +- steps: defines staged rollout progression +- analysis: integrates automated checks (metrics, tests) during rollout +- pause: enables manual or timed pauses between steps +- trafficRouting: controls how traffic is split between versions (with ingress/service mesh) + + +## Canary Deployment + +### Strategy configuration explained + +The rollout uses a canary strategy to gradually shift traffic from the old version to the new one. It is configured in steps (20%, 40%, 60%, 80%, 100%) with pauses to allow validation and manual control. This approach reduces risk by exposing the new version to a small part of users before full deployment. + +### Step-by-step rollout progression (screenshots from dashboard) + +![](./../docs/screenshots/lab14-shots/canary-prom-1.png) +![](./../docs/screenshots/lab14-shots/canary-prom-2.png) +![](./../docs/screenshots/lab14-shots/canary-prom-3.png) + +### Promotion and abort demonstration + +Promotion (screenshots can be seen in the prev step) + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl argo rollouts get rollout myapp-app-python -n argo-rollouts +Name: myapp-app-python +Namespace: argo-rollouts +Status: ॥ Paused +Message: CanaryPauseStep +Strategy: Canary + Step: 1/9 + SetWeight: 20 + ActualWeight: 25 +Images: fountainer/my-app:16-04 (canary, stable) +Replicas: + Desired: 3 + Current: 4 + Updated: 1 + Ready: 4 + Available: 4 + +NAME KIND STATUS AGE INFO +⟳ myapp-app-python Rollout ॥ Paused 17m +├──# revision:2 +│ └──⧉ myapp-app-python-76b59b6c66 ReplicaSet ✔ Healthy 69s canary +│ └──□ myapp-app-python-76b59b6c66-pgtgq Pod ✔ Running 68s ready:1/1 +└──# revision:1 + └──⧉ myapp-app-python-5bc87cfdf6 ReplicaSet ✔ Healthy 17m stable + ├──□ myapp-app-python-5bc87cfdf6-2tzkc Pod ✔ Running 17m ready:1/1 + ├──□ myapp-app-python-5bc87cfdf6-bnpd6 Pod ✔ Running 17m ready:1/1 + └──□ myapp-app-python-5bc87cfdf6-qfg9s Pod ✔ Running 17m ready:1/1 +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl argo rollouts promote myapp-app-python -n argo-rollouts +rollout 'myapp-app-python' promoted +``` + +Abort + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get rollouts -n argo-rollouts +NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE +myapp-app-python 3 4 1 4 31m +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl argo rollouts abort myapp-app-python -n argo-rollouts +rollout 'myapp-app-python' aborted +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl argo rollouts get rollout myapp-app-python -n argo-rollouts +Name: myapp-app-python +Namespace: argo-rollouts +Status: ✖ Degraded +Message: RolloutAborted: Rollout aborted update to revision 3 +Strategy: Canary + Step: 0/9 + SetWeight: 0 + ActualWeight: 0 +Images: fountainer/my-app:16-04 (stable) +Replicas: + Desired: 3 + Current: 3 + Updated: 0 + Ready: 3 + Available: 3 + +NAME KIND STATUS AGE INFO +⟳ myapp-app-python Rollout ✖ Degraded 32m +├──# revision:3 +│ └──⧉ myapp-app-python-5bc87cfdf6 ReplicaSet • ScaledDown 32m canary +└──# revision:2 + └──⧉ myapp-app-python-76b59b6c66 ReplicaSet ✔ Healthy 16m stable + ├──□ myapp-app-python-76b59b6c66-pgtgq Pod ✔ Running 16m ready:1/1 + ├──□ myapp-app-python-76b59b6c66-7cwr4 Pod ✔ Running 10m ready:1/1 + └──□ myapp-app-python-76b59b6c66-skfdd Pod ✔ Running 10m ready:1/1 +``` +![](./../docs/screenshots/lab14-shots/canary-abort.png) + +## Blue-Green Deployment + +### Strategy configuration explained + +The blue-green strategy uses two environments: active and preview. The preview service runs the new version while the active service continues serving production traffic. After testing, the active service is switched to the new version instantly when promoted. This allows safe testing before release and quick rollback if needed. + +### Preview vs active service + +The active service is used by users in production and always points to the stable version. The preview service is used to test the new version before it is promoted. This separation ensures the new version can be verified without affecting real users. + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl port-forward svc/myapp-app-python-preview 8081:80 -n argo-rollouts +Forwarding from 127.0.0.1:8081 -> 12345 +Forwarding from [::1]:8081 -> 12345 +Handling connection for 8081 +Handling connection for 8081 +``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl port-forward svc/myapp-app-python-service 8080:80 -n argo-rollouts +Forwarding from 127.0.0.1:8080 -> 12345 +Forwarding from [::1]:8080 -> 12345 +Handling connection for 8080 +Handling connection for 8080 +``` + +### Promotion process + +Promotion + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm upgrade --install myapp . -n argo-rollouts +Release "myapp" has been upgraded. Happy Helming! +NAME: myapp +LAST DEPLOYED: Thu Apr 30 23:12:57 2026 +NAMESPACE: argo-rollouts +STATUS: deployed +REVISION: 9 +DESCRIPTION: Upgrade complete +TEST SUITE: None +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pods -n argo-rollouts +kubectl get svc -n argo-rollouts +NAME READY STATUS RESTARTS AGE +argo-rollouts-5f64f8d68-zxx5z 1/1 Running 0 6h24m +argo-rollouts-dashboard-755bbc64c-pnkl6 1/1 Running 0 6h12m +myapp-app-python-76b59b6c66-7cwr4 1/1 Running 0 37m +myapp-app-python-76b59b6c66-pgtgq 1/1 Running 0 43m +myapp-app-python-76b59b6c66-skfdd 1/1 Running 0 37m +myapp-app-python-f7cddd7c7-5nvtx 1/1 Running 0 12m +myapp-app-python-f7cddd7c7-xng4z 1/1 Running 0 12m +myapp-app-python-f7cddd7c7-zjfpv 1/1 Running 0 12m +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +argo-rollouts-dashboard ClusterIP 10.106.240.192 3100/TCP 6h12m +argo-rollouts-metrics ClusterIP 10.109.176.51 8090/TCP 6h24m +myapp-app-python-preview ClusterIP 10.97.144.248 80/TCP 16m +myapp-app-python-service NodePort 10.101.217.107 80:30009/TCP 59m +``` + +![](./../docs/screenshots/lab14-shots/blue-green-1.png) +![](./../docs/screenshots/lab14-shots/bg-2.png) +![](./../docs/screenshots/lab14-shots/bg-4.png) + +Rollback + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl argo rollouts undo myapp-app-python -n argo-rollouts +rollout 'myapp-app-python' undo +``` +![](./../docs/screenshots/lab14-shots/bg-5.png) + + +## Strategy Comparison + +### When to use canary vs blue-green + +canary is used when you want to slowly roll out changes to users and reduce risk step by step. blue-green is used when you want an instant switch between versions after testing + +### Pros and cons of each + +- canary is safer for production because it exposes changes gradually, but it takes longer and is more complex to monitor + +- blue-green is faster and simpler at switch time, but requires double resources and has less gradual control. + +### Your recommendation for different scenarios + +use canary for production systems where stability is critical. use blue-green for fast releases or when you want quick testing and instant rollback. + +## CLI Commands Reference + +### Commands you used + +```kubectl argo rollouts get rollout -w``` is used to watch rollout progress. ```kubectl argo rollouts promote``` is used to move to the next step in canary or switch in blue-green. ```kubectl argo rollouts undo``` is used to rollback to the previous version. + +### Monitoring and troubleshooting + +```kubectl get pods```, ```kubectl get svc```, and ```kubectl describe rollout``` are used to check cluster state and debug issues. dashboard is used to visually monitor rollout progress and traffic changes. \ No newline at end of file diff --git a/app_python/docs/LAB15.md b/app_python/docs/LAB15.md new file mode 100644 index 0000000000..b5a5b60b72 --- /dev/null +++ b/app_python/docs/LAB15.md @@ -0,0 +1,168 @@ +# Documentation + +## StatefulSet Overview + +### Why StatefulSet + +It is used when pods need stable identity and storage, like each pod keeping its own data and name even after restart. + +### Differences from Deployment + +Key differences: +- deployment pods are interchangeable and can change names/storage after restarts, while statefulset pods have fixed names (pod-0, pod-1) and their own persistent storage. + +When to use Deployment vs StatefulSet: +- deployment is used for stateless apps (like web servers), and statefulset for apps that need stable data and identity (like databases). + +Examples of stateful workloads: +- databases like mysql/postgresql, message queues, systems like elasticsearch + +### Headless Services + +What is a headless service (clusterIP: None)? +- a service without a cluster ip that lets you directly access individual pods instead of load balancing + +How DNS works with StatefulSets? +- each pod gets its own dns name like pod-0.service-name.namespace.svc.cluster.local, and they can be addressed individually + +## Resource Verification + +### Output of kubectl get pod,sts,svc,pvc + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get statefulset +NAME READY AGE +myapp-app-python 3/3 38s +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pods +NAME READY STATUS RESTARTS AGE +my-app-app-python-5f57899757-4phmz 1/1 Running 1 (7d4h ago) 7d6h +my-app-app-python-5f57899757-6sj7k 1/1 Running 1 (7d4h ago) 7d5h +my-app-app-python-5f57899757-75mlj 1/1 Running 1 (7d4h ago) 7d5h +myapp-app-python-0 1/1 Running 0 42s +myapp-app-python-1 1/1 Running 0 25s +myapp-app-python-2 1/1 Running 0 16s +myapp-app-python-5bc87cfdf6-dhkt6 1/1 Running 0 42s +myapp-app-python-5bc87cfdf6-mxpkd 1/1 Running 0 42s +myapp-app-python-5bc87cfdf6-wpc68 1/1 Running 0 42s +myapp-app-python-7dc6cbf89f-46pbw 1/1 Running 0 42s +myapp-app-python-7dc6cbf89f-9krh8 1/1 Running 0 42s +myapp-app-python-7dc6cbf89f-lp4rh 1/1 Running 0 42s +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pvc +NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS VOLUMEATTRIBUTESCLASS AGE +data-volume-myapp-app-python-0 Bound pvc-2a043668-bbae-4c8d-86dc-ae89242a4b28 100Mi RWO standard 53s +data-volume-myapp-app-python-1 Bound pvc-f9152007-9fff-4292-bc28-d1bc16b0214e 100Mi RWO standard 36s +data-volume-myapp-app-python-2 Bound pvc-cec60c23-bdb5-44df-bf9f-9e2938726dc6 100Mi RWO standard 27s +my-app-app-python-data Bound pvc-a5009930-2af6-4223-8fad-16257b59e9aa 100Mi RWO standard 7d6h +myapp-app-python-data Bound pvc-22a66b4f-e1f6-486f-a528-76f27f090535 100Mi RWO standard 53s +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pod,sts,svc,pvc +NAME READY STATUS RESTARTS AGE +pod/my-app-app-python-5f57899757-4phmz 1/1 Running 1 (7d4h ago) 7d6h +pod/my-app-app-python-5f57899757-6sj7k 1/1 Running 1 (7d4h ago) 7d5h +pod/my-app-app-python-5f57899757-75mlj 1/1 Running 1 (7d4h ago) 7d5h +pod/myapp-app-python-0 1/1 Running 0 99s +pod/myapp-app-python-1 1/1 Running 0 82s +pod/myapp-app-python-2 1/1 Running 0 73s +pod/myapp-app-python-5bc87cfdf6-dhkt6 1/1 Running 0 99s +pod/myapp-app-python-5bc87cfdf6-mxpkd 1/1 Running 0 99s +pod/myapp-app-python-5bc87cfdf6-wpc68 1/1 Running 0 99s +pod/myapp-app-python-7dc6cbf89f-46pbw 1/1 Running 0 99s +pod/myapp-app-python-7dc6cbf89f-9krh8 1/1 Running 0 99s +pod/myapp-app-python-7dc6cbf89f-lp4rh 1/1 Running 0 99s + +NAME READY AGE +statefulset.apps/myapp-app-python 3/3 99s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/kubernetes ClusterIP 10.96.0.1 443/TCP 7d8h +service/myapp-app-python-preview ClusterIP 10.98.51.97 80/TCP 99s +service/myapp-app-python-service NodePort 10.110.182.139 80:30009/TCP 99s + +NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS VOLUMEATTRIBUTESCLASS AGE +persistentvolumeclaim/data-volume-myapp-app-python-0 Bound pvc-2a043668-bbae-4c8d-86dc-ae89242a4b28 100Mi RWO standard 99s +persistentvolumeclaim/data-volume-myapp-app-python-1 Bound pvc-f9152007-9fff-4292-bc28-d1bc16b0214e 100Mi RWO standard 82s +persistentvolumeclaim/data-volume-myapp-app-python-2 Bound pvc-cec60c23-bdb5-44df-bf9f-9e2938726dc6 100Mi RWO standard 73s +persistentvolumeclaim/my-app-app-python-data Bound pvc-a5009930-2af6-4223-8fad-16257b59e9aa 100Mi RWO standard 7d6h +persistentvolumeclaim/myapp-app-python-data Bound pvc-22a66b4f-e1f6-486f-a528-76f27f090535 100Mi RWO standard 99s +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` + +## Network Identity + +### DNS resolution outputs + +the naming pattern is ```.``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec -it myapp-app-python-0 -- /bin/sh +$ getent hosts myapp-app-python-0.myapp-app-python-headless +10.244.0.177 myapp-app-python-0.myapp-app-python-headless.default.svc.cluster.local +$ getent hosts myapp-app-python-1.myapp-app-python-headless +10.244.0.179 myapp-app-python-1.myapp-app-python-headless.default.svc.cluster.local +$ getent hosts myapp-app-python-2.myapp-app-python-headless +10.244.0.180 myapp-app-python-2.myapp-app-python-headless.default.svc.cluster.local +``` + +## Per-Pod Storage Evidence + +### Different visit counts per pod + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl port-forward pod/myapp-app-python-0 8080:12345 +Forwarding from 127.0.0.1:8080 -> 12345 +Forwarding from [::1]:8080 -> 12345 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +``` + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % pyenv shell devops +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl port-forward pod/myapp-app-python-1 8081:12345 +Forwarding from 127.0.0.1:8081 -> 12345 +Forwarding from [::1]:8081 -> 12345 +Handling connection for 8081 +Handling connection for 8081 +Handling connection for 8081 +Handling connection for 8081 +Handling connection for 8081 +``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl port-forward pod/myapp-app-python-2 8082:12345 +Forwarding from 127.0.0.1:8082 -> 12345 +Forwarding from [::1]:8082 -> 12345 +Handling connection for 8082 +Handling connection for 8082 +Handling connection for 8082 +Handling connection for 8082 +``` +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % curl localhost:8080/visits +{ + "visits": 13 +} +(devops) fountainer@Veronicas-MacBook-Air app_python % curl localhost:8081/visits +{ + "visits": 7 +} +(devops) fountainer@Veronicas-MacBook-Air app_python % curl localhost:8082/visits +{ + "visits": 2 +} +``` + +![](./../docs/screenshots/lab15-shots/visits-diff.png) + +## Persistence Test + +### data survives pod deletion + +![](./../docs/screenshots/lab15-shots/pers_test.png) \ No newline at end of file diff --git a/app_python/docs/LAB16.md b/app_python/docs/LAB16.md new file mode 100644 index 0000000000..b71aebd57e --- /dev/null +++ b/app_python/docs/LAB16.md @@ -0,0 +1,227 @@ +# Documentation + +## Stack Components + +### Descriptions in your own words + +- Prometheus Operator: it's a kubernates tool that allows you to automate prometheus deployment and management. it provides a set of custom resource definitions, and you can make your own configuration with those. + +- Prometheus: it's a tool for monitoring and alerting, it stores metrics as a series of timestampts. + +- Alertmanager: an instruments to manage alerts. when metrics reach invalid state, alertmanager will receive alerts, group and send them to asignees. you can configure when to silence alerts or start reaching out to the next person if the first one is not responding (it's an escalation), and create other custom settings. + +- Grafana: it is a dashboard for tracking the current state of the system by visualising logs and metrics. you can define alert rules there to see if the new metric value is out of the valid tresholds. + +- kube-state-metrics: it's a service that exposes metrics related to kubernates objects, they are created automatically and describe your pods current state. + +- node-exporter: it's an agent that exposes internal metrics for a node (like cpu, memory, etc), then prometheus can scrape those metrics. + +## Installation Evidence + +### kubectl get po,svc -n monitoring + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % helm repo add prometheus-community https://prometheus-community.github.io/helm-charts +"prometheus-community" already exists with the same configuration, skipping +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % helm repo update +Hang tight while we grab the latest from your chart repositories... +...Successfully got an update from the "hashicorp" chart repository +...Successfully got an update from the "argo" chart repository +...Successfully got an update from the "prometheus-community" chart repository +Update Complete. ⎈Happy Helming!⎈ +``` + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get po,svc -n monitoring +NAME READY STATUS RESTARTS AGE +pod/alertmanager-monitoring-kube-prometheus-alertmanager-0 2/2 Running 0 2m34s +pod/monitoring-grafana-bbc5c674-8cbd9 3/3 Running 0 2m56s +pod/monitoring-kube-prometheus-operator-54f68d65b4-99ck2 1/1 Running 0 2m56s +pod/monitoring-kube-state-metrics-5957bd45bc-5rpqr 1/1 Running 0 2m56s +pod/monitoring-prometheus-node-exporter-c8fg6 1/1 Running 0 2m57s +pod/prometheus-monitoring-kube-prometheus-prometheus-0 2/2 Running 0 2m34s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/alertmanager-operated ClusterIP None 9093/TCP,9094/TCP,9094/UDP 2m34s +service/monitoring-grafana ClusterIP 10.110.156.182 80/TCP 2m57s +service/monitoring-kube-prometheus-alertmanager ClusterIP 10.111.243.229 9093/TCP,8080/TCP 2m57s +service/monitoring-kube-prometheus-operator ClusterIP 10.99.16.80 443/TCP 2m57s +service/monitoring-kube-prometheus-prometheus ClusterIP 10.106.17.206 9090/TCP,8080/TCP 2m57s +service/monitoring-kube-state-metrics ClusterIP 10.102.26.186 8080/TCP 2m57s +service/monitoring-prometheus-node-exporter ClusterIP 10.100.205.92 9100/TCP 2m57s +service/prometheus-operated ClusterIP None 9090/TCP 2m34s +``` + +## Dashboard Answers + +### Pod Resources: CPU/memory usage of your StatefulSet + +Due to the pods and the app itself being very lightweight, CPU and memory usage never went higher than initially allocated resources (100m CPU and 128Mi memory). Even under high load (I used multiple loops with curl), the initial resources were enough. You will see more detailed usages info in the next question. + +Example for pod 2: + +![](./../docs/screenshots/lab16-shots/cpupod2.png) + +![](./../docs/screenshots/lab16-shots/memorypod2.png) + +### Namespace Analysis: Which pods use most/least CPU in default namespace? + +I decided to use Prometheus for evidence, since the resource usage was really low, and didn't show up properly in Grafana. + +curl I used (the first count is much bigger since I previously tested only with pod 2) + +![](./../docs/screenshots/lab16-shots/curl.png) + +usage + +![](./../docs/screenshots/lab16-shots/namespace%20usage.png) + +As we can see, all statefulset pods used roughly the same amount of CPU and memory resources. This is anticipated, because load balancing is used for routing traffic to different pods. + +### Node Metrics: Memory usage (% and MB), CPU cores + +CPU and Memory usage for the whole minikube node was: + +![](./../docs/screenshots/lab16-shots/node%20cpu%20memory.png) + +It is much higher than resources used in statefulset since the node contains all different namespaces in my minikube cluster. + +### Kubelet: How many pods/containers managed? + +16 pods and 41 containers + +![](./../docs/screenshots/lab16-shots/pods%20managed.png) + +### Network: Traffic for pods in default namespace + +![](./../docs/screenshots/lab16-shots/network.png) + +### Alerts: How many active alerts? Check Alertmanager UI + +![](./../docs/screenshots/lab16-shots/alert.png) + +## Init Containers: Implementation and proof of success + +I implemented two init container patterns. First one downloads a file with wget into a shared emptyDir volume and the main container successfully accessed it from /data/index.html. Second one uses a wait-for-service init container that continuously checks the nginx service with wget and only starts the main container after the service becomes reachable. + +### Init container + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 0/1 Init:0/1 0 2s +myapp-app-python-0 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-1 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-2 1/1 Running 3 (6h15m ago) 7d20h +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 0/1 PodInitializing 0 4s +myapp-app-python-0 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-1 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-2 1/1 Running 3 (6h15m ago) 7d20h +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 1/1 Running 0 5s +myapp-app-python-0 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-1 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-2 1/1 Running 3 (6h15m ago) 7d20h +``` +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl logs init-download-pod -c init-download +Connecting to example.com (172.66.147.243:443) +wget: note: TLS certificate validation not implemented +saving to '/work-dir/index.html' +index.html 100% |********************************| 528 0:00:00 ETA +'/work-dir/index.html' saved +``` + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl exec init-download-pod -- cat /data/index.html +Defaulted container "main-app" out of: main-app, init-download (init) +Example Domain

Example Domain

This domain is for use in documentation examples without needing permission. Avoid use in operations.

Learn more

+``` + +### Waiting for service container + +```bash +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl apply -f waiting.yaml +pod/wait-service-pod created +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 1/1 Running 0 51m +myapp-app-python-0 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-1 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-2 1/1 Running 3 (7h6m ago) 7d21h +wait-service-pod 0/1 Init:0/1 0 22s +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl logs wait-service-pod -c wait-for-service +wget: bad address 'myservice.default.svc.cluster.local' +waiting for service +wget: bad address 'myservice.default.svc.cluster.local' +waiting for service +wget: bad address 'myservice.default.svc.cluster.local' +waiting for service +wget: bad address 'myservice.default.svc.cluster.local' +waiting for service +wget: bad address 'myservice.default.svc.cluster.local' +waiting for service +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl apply -f nginx.yaml +deployment.apps/myservice created +service/myservice created +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 1/1 Running 0 51m +myapp-app-python-0 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-1 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-2 1/1 Running 3 (7h6m ago) 7d21h +myservice-ffc6675d7-pmjfr 1/1 Running 0 3s +wait-service-pod 0/1 Init:0/1 0 55s +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 1/1 Running 0 51m +myapp-app-python-0 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-1 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-2 1/1 Running 3 (7h6m ago) 7d21h +myservice-ffc6675d7-pmjfr 1/1 Running 0 5s +wait-service-pod 0/1 PodInitializing 0 57s +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 1/1 Running 0 51m +myapp-app-python-0 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-1 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-2 1/1 Running 3 (7h6m ago) 7d21h +myservice-ffc6675d7-pmjfr 1/1 Running 0 7s +wait-service-pod 1/1 Running 0 59s +``` + +After service was discovered: + +```bash +waiting for service + + + +Welcome to nginx! + + + +

Welcome to nginx!

+

If you see this page, nginx is successfully installed and working. +Further configuration is required for the web server, reverse proxy, +API gateway, load balancer, content cache, or other features.

+ +

For online documentation and support please refer to +nginx.org.
+To engage with the community please visit +community.nginx.org.
+For enterprise grade support, professional services, additional +security features and capabilities please refer to +f5.com/nginx.

+ +

Thank you for using nginx.

+ + +``` \ No newline at end of file diff --git a/app_python/docs/LAB17.md b/app_python/docs/LAB17.md new file mode 100644 index 0000000000..7a1216a967 --- /dev/null +++ b/app_python/docs/LAB17.md @@ -0,0 +1,215 @@ +# Documentation + +## Deployment summary + +### Worker URL + +[https://edge-api.v-levasheva.workers.dev](https://edge-api.v-levasheva.workers.dev) + +### Main routes + +/ for general app info + +/health for health status + +/edge for cloudflare edge metadata + +/counter for a persistent KV-based request counter, which shows the number of visits for / route + +/admin-check is for checking if the requester is an admin, it uses secrets API_TOKEN and ADMIN_EMAIL, and the requester should provide valid token and email in the request headers + +and also there is "Not Found" response for non-existent route + +### Configuration used + +the worker was configured using wrangler.jsonc, which defines the worker name, entrypoint (src/index.ts), compatibility date, environment variables, and resource bindings. the project uses a TypeScript Worker template and includes an APP_NAME variable binding together with a COUNTER_KV KV namespace binding used for persistent storage in the /counter endpoint. + +## Evidence + +### Screenshot of Cloudflare dashboard + +![](./../docs/screenshots/lab17-shots/dashboard.png) + +### Example /edge JSON response + +Firstly, the local testing of all endpoints (for the deployed /edge some info such as asn and httpProtocol were added): + +![](./../docs/screenshots/lab17-shots/endpoints%20local.png) + +And the /edge endpoint in the deployed worker: + +![](./../docs/screenshots/lab17-shots/edge%20deployed.png) + +### How Workers distributes execution globally? + +cloudflare workers are automatically executed on cloudflare edge locations around the world, so requests are handled close to the user without manually selecting regions. unlike traditional VM or PaaS platforms where you often deploy separately to regions, workers use cloudflare’s global network automatically, so there is no separate “deploy to 3 regions” step. + +### The difference between workers.dev, Routes, and Custom Domains + +- workers.dev is the default public cloudflare subdomain automatically provided for testing and accessing workers + +- routes are specific url endpoints that worker will provide access to + +- custom domains allow exposing the worker directly through an owned custom domain, not through a provided workers.dev + +## Configuration, Secrets & Persistence + +### Explain why plaintext vars are not suitable for secrets + +variables I added: "APP_NAME" and "COURSE_NAME" + +plaintext vars are not safe for secrets because they are stored in config and visible in repo and dashboard, so anyone can read them + +### Secrets + +I added 2 secrets: API_TOKEN and ADMIN_EMAIL. They are used in the /admin-check endpoint, where the requester can pass their access token and email and see if they can be authenticated as an admin. + +```bash +(devops) fountainer@Veronicas-MacBook-Air edge-api % npx wrangler secret list +[ + { + "name": "ADMIN_EMAIL", + "type": "secret_text" + }, + { + "name": "API_TOKEN", + "type": "secret_text" + } +] +``` + +![](./../docs/screenshots/lab17-shots/secrets.png) + +### Workers KV persistence + +### Document what you stored and how you verified it + +I stored the number of visits of the / endpoint. Each time / is visited, the counter increases by one, and visits value is updated. The value then can be accessed through the /visits endpoint. + +The persistance verification: + +![](./../docs/screenshots/lab17-shots/persistance.png) + +## Observability & Operations + +### Example log or metrics screenshot + +Logs + +![](./../docs/screenshots/lab17-shots/logs.png) + +Metrics + +![](./../docs/screenshots/lab17-shots/metrics.png) + +I looked at errors, requests, and request duration metrics for all deployed versions for the last 24 hours. + +requests: total of 192. this metrics shows how many http requests hit the Worker through all endpoints. + +errors: 0 errors. it can be confusing since I intentially hit invalid endpoint such as https://edge-api.v-levasheva.workers.dev/smth a lot of times to get error: "Not Found", but the case was that the Worker does not count 404 responses as errors, the real errors that are considered are runtime failures, which I did not have. + +request duration: 3.15 ms on average. this metric shows the latency - how much it takes to process a request and send back a response. + +### Multiple Deployments + +* I created about 10 deployments but put here last 2 for readability + +```bash +(devops) fountainer@Veronicas-MacBook-Air edge-api % npx wrangler deployments list + + ⛅️ wrangler 4.90.0 +Created: 2026-05-10T16:57:52.287Z +Author: v.levasheva@innopolis.university +Source: Unknown (deployment) +Message: - +Version(s): (100%) 4844c942-5e05-4199-999f-b54af219ed99 + Created: 2026-05-10T16:48:11.805Z + Tag: - + Message: - + +Created: 2026-05-10T17:01:05.875Z +Author: v.levasheva@innopolis.university +Source: Unknown (deployment) +Message: - +Version(s): (100%) 9f0c5465-b3c2-462d-b199-bb1a6dc23d9f + Created: 2026-05-10T17:01:03.267Z + Tag: - + Message: - +``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air edge-api % npx wrangler rollback + + ⛅️ wrangler 4.90.0 +─────────────────── +├ Your current deployment has 1 version(s): +│ +│ (100%) 9f0c5465-b3c2-462d-b199-bb1a6dc23d9f +│ Created: 2026-05-10T17:01:03.267267Z +│ Tag: - +│ Message: - +│ +✔ Please provide an optional message for this rollback (120 characters max) … test rollback +│ +├  WARNING  You are about to rollback to Worker Version 4844c942-5e05-4199-999f-b54af219ed99. +│ This will immediately replace the current deployment and become the active deployment across all your deployed triggers. +│ However, your local development environment will not be affected by this rollback. +│ Rolling back to a previous deployment will not rollback any of the bound resources (Durable Object, D1, R2, KV, etc). +│ +│ (100%) 4844c942-5e05-4199-999f-b54af219ed99 +│ Created: 2026-05-10T16:48:11.805042Z +│ Tag: - +│ Message: - +│ +✔ Are you sure you want to deploy this Worker Version to 100% of traffic? … yes +Performing rollback... +│ +╰  SUCCESS  Worker Version 4844c942-5e05-4199-999f-b54af219ed99 has been deployed to 100% of traffic. + +Current Version ID: 4844c942-5e05-4199-999f-b54af219ed99 +``` + +## Kubernetes vs Cloudflare Workers Comparison + +| Aspect | Kubernetes | Cloudflare Workers | +|--------|------------|--------------------| +| Setup complexity | really high, you should create cluster setup, manifests, networking, monitoring, and scaling configuration yourself | much simpler, just write code and deploy with minimal config | +| Deployment speed | slower, containers must build and start | very fast, seconds are enough | +| Global distribution | usually requires manual configuration | automatic global edge distribution | +| Cost (for small apps) | can become expensive due to always-running release | cheaper for lightweight APIs and low traffic apps | +| State/persistence model | persistent volumes, databases, StatefulSets | stateless by default, persistence through KV | +| Control/flexibility | very high control over runtime, networking, and storage | less low-level control, but much simpler to use | +| Best use case | complex and heavy programs, projects that require customisation | edge APIs, lightweight services, and globally distributed low-latency apps | + +## When to Use Each + +### Scenarios favoring Kubernetes + +- complex applications with multiple services +- custom configuration +- long-running work processes + +### Scenarios favoring Workers + +- lightweight APIs +- edge services +- globally distributed applications with low latency requirements + +### Your recommendation + +I would use k8s and VMs for big projects that require heavy customisation, and Cloudflare Workers for lightweight apps that will benefit immensely from locating close to the users. + +## Reflection + +### What felt easier than Kubernetes? + +- to be honest, everything felt easier + +### What felt more constrained? + +- no control over networking, no customisation, no manual resource distribution and controllable scaling. + +### What changed because Workers is not a Docker host? + +- as opposed to docker, Workers provide serverless architecture, and Workers runtime model is forced. moreover, I didn't have to keep process running locally, like with docker containers, it was nice. + diff --git a/app_python/docs/screenshots/01-main-endpoint.png b/app_python/docs/screenshots/01-main-endpoint.png new file mode 100644 index 0000000000..ba33e3a732 Binary files /dev/null and b/app_python/docs/screenshots/01-main-endpoint.png differ diff --git a/app_python/docs/screenshots/02-health-check.png b/app_python/docs/screenshots/02-health-check.png new file mode 100644 index 0000000000..aeb0c64170 Binary files /dev/null and b/app_python/docs/screenshots/02-health-check.png differ diff --git a/app_python/docs/screenshots/03-formatted-output.png b/app_python/docs/screenshots/03-formatted-output.png new file mode 100644 index 0000000000..1d5b985415 Binary files /dev/null and b/app_python/docs/screenshots/03-formatted-output.png differ diff --git a/app_python/docs/screenshots/lab02-shots/build.png b/app_python/docs/screenshots/lab02-shots/build.png new file mode 100644 index 0000000000..83b9fec021 Binary files /dev/null and b/app_python/docs/screenshots/lab02-shots/build.png differ diff --git a/app_python/docs/screenshots/lab02-shots/pull.png b/app_python/docs/screenshots/lab02-shots/pull.png new file mode 100644 index 0000000000..b5aa80a5b0 Binary files /dev/null and b/app_python/docs/screenshots/lab02-shots/pull.png differ diff --git a/app_python/docs/screenshots/lab02-shots/push.png b/app_python/docs/screenshots/lab02-shots/push.png new file mode 100644 index 0000000000..dc267951d2 Binary files /dev/null and b/app_python/docs/screenshots/lab02-shots/push.png differ diff --git a/app_python/docs/screenshots/lab02-shots/run.png b/app_python/docs/screenshots/lab02-shots/run.png new file mode 100644 index 0000000000..9cb5eb6708 Binary files /dev/null and b/app_python/docs/screenshots/lab02-shots/run.png differ diff --git a/app_python/docs/screenshots/lab02-shots/test.png b/app_python/docs/screenshots/lab02-shots/test.png new file mode 100644 index 0000000000..48d590cfa6 Binary files /dev/null and b/app_python/docs/screenshots/lab02-shots/test.png differ diff --git a/app_python/docs/screenshots/lab03-shots/images with tags docker hub.png b/app_python/docs/screenshots/lab03-shots/images with tags docker hub.png new file mode 100644 index 0000000000..4919561bfd Binary files /dev/null and b/app_python/docs/screenshots/lab03-shots/images with tags docker hub.png differ diff --git a/app_python/docs/screenshots/lab03-shots/improved perf.png b/app_python/docs/screenshots/lab03-shots/improved perf.png new file mode 100644 index 0000000000..dffca15721 Binary files /dev/null and b/app_python/docs/screenshots/lab03-shots/improved perf.png differ diff --git a/app_python/docs/screenshots/lab03-shots/pipeline success.png b/app_python/docs/screenshots/lab03-shots/pipeline success.png new file mode 100644 index 0000000000..e5c638d566 Binary files /dev/null and b/app_python/docs/screenshots/lab03-shots/pipeline success.png differ diff --git a/app_python/docs/screenshots/lab03-shots/unit test output.png b/app_python/docs/screenshots/lab03-shots/unit test output.png new file mode 100644 index 0000000000..a3beab71dd Binary files /dev/null and b/app_python/docs/screenshots/lab03-shots/unit test output.png differ diff --git a/app_python/docs/screenshots/lab04-shots/pulumi preview.png b/app_python/docs/screenshots/lab04-shots/pulumi preview.png new file mode 100644 index 0000000000..5ba4f05400 Binary files /dev/null and b/app_python/docs/screenshots/lab04-shots/pulumi preview.png differ diff --git a/app_python/docs/screenshots/lab04-shots/pulumi ssh.png b/app_python/docs/screenshots/lab04-shots/pulumi ssh.png new file mode 100644 index 0000000000..2311bbfb38 Binary files /dev/null and b/app_python/docs/screenshots/lab04-shots/pulumi ssh.png differ diff --git a/app_python/docs/screenshots/lab04-shots/pulumi up.png b/app_python/docs/screenshots/lab04-shots/pulumi up.png new file mode 100644 index 0000000000..54bf4d50e7 Binary files /dev/null and b/app_python/docs/screenshots/lab04-shots/pulumi up.png differ diff --git a/app_python/docs/screenshots/lab04-shots/ssh output terraform.png b/app_python/docs/screenshots/lab04-shots/ssh output terraform.png new file mode 100644 index 0000000000..463910cf4a Binary files /dev/null and b/app_python/docs/screenshots/lab04-shots/ssh output terraform.png differ diff --git a/app_python/docs/screenshots/lab04-shots/terraform apply-1.png b/app_python/docs/screenshots/lab04-shots/terraform apply-1.png new file mode 100644 index 0000000000..7598bfbefe Binary files /dev/null and b/app_python/docs/screenshots/lab04-shots/terraform apply-1.png differ diff --git a/app_python/docs/screenshots/lab04-shots/terraform apply-2.png b/app_python/docs/screenshots/lab04-shots/terraform apply-2.png new file mode 100644 index 0000000000..7715fc8423 Binary files /dev/null and b/app_python/docs/screenshots/lab04-shots/terraform apply-2.png differ diff --git a/app_python/docs/screenshots/lab04-shots/terraform destroy.png b/app_python/docs/screenshots/lab04-shots/terraform destroy.png new file mode 100644 index 0000000000..d9137cc00e Binary files /dev/null and b/app_python/docs/screenshots/lab04-shots/terraform destroy.png differ diff --git a/app_python/docs/screenshots/lab04-shots/terraform plan.png b/app_python/docs/screenshots/lab04-shots/terraform plan.png new file mode 100644 index 0000000000..e73c54a786 Binary files /dev/null and b/app_python/docs/screenshots/lab04-shots/terraform plan.png differ diff --git a/app_python/docs/screenshots/lab04-shots/vm status.png b/app_python/docs/screenshots/lab04-shots/vm status.png new file mode 100644 index 0000000000..95c51dae37 Binary files /dev/null and b/app_python/docs/screenshots/lab04-shots/vm status.png differ diff --git a/app_python/docs/screenshots/lab05-shots/encrypted.png b/app_python/docs/screenshots/lab05-shots/encrypted.png new file mode 100644 index 0000000000..e874cc9e27 Binary files /dev/null and b/app_python/docs/screenshots/lab05-shots/encrypted.png differ diff --git a/app_python/docs/screenshots/lab06-shots/Check mode to see what would run.png b/app_python/docs/screenshots/lab06-shots/Check mode to see what would run.png new file mode 100644 index 0000000000..ce2e9eab9f Binary files /dev/null and b/app_python/docs/screenshots/lab06-shots/Check mode to see what would run.png differ diff --git a/app_python/docs/screenshots/lab06-shots/Install packages only across all roles.png b/app_python/docs/screenshots/lab06-shots/Install packages only across all roles.png new file mode 100644 index 0000000000..a1e3ff8169 Binary files /dev/null and b/app_python/docs/screenshots/lab06-shots/Install packages only across all roles.png differ diff --git a/app_python/docs/screenshots/lab06-shots/Run only docker installation tasks.png b/app_python/docs/screenshots/lab06-shots/Run only docker installation tasks.png new file mode 100644 index 0000000000..4d4adec394 Binary files /dev/null and b/app_python/docs/screenshots/lab06-shots/Run only docker installation tasks.png differ diff --git a/app_python/docs/screenshots/lab06-shots/Skip common role.png b/app_python/docs/screenshots/lab06-shots/Skip common role.png new file mode 100644 index 0000000000..0d15d7b10e Binary files /dev/null and b/app_python/docs/screenshots/lab06-shots/Skip common role.png differ diff --git a/app_python/docs/screenshots/lab06-shots/Test provision with only docker.png b/app_python/docs/screenshots/lab06-shots/Test provision with only docker.png new file mode 100644 index 0000000000..44d8374d37 Binary files /dev/null and b/app_python/docs/screenshots/lab06-shots/Test provision with only docker.png differ diff --git a/app_python/docs/screenshots/lab06-shots/app running after clean reinstall.png b/app_python/docs/screenshots/lab06-shots/app running after clean reinstall.png new file mode 100644 index 0000000000..8705183b16 Binary files /dev/null and b/app_python/docs/screenshots/lab06-shots/app running after clean reinstall.png differ diff --git a/app_python/docs/screenshots/lab06-shots/ci:cd success.png b/app_python/docs/screenshots/lab06-shots/ci:cd success.png new file mode 100644 index 0000000000..aec7e3de34 Binary files /dev/null and b/app_python/docs/screenshots/lab06-shots/ci:cd success.png differ diff --git a/app_python/docs/screenshots/lab07-shots/grafana dashboard.png b/app_python/docs/screenshots/lab07-shots/grafana dashboard.png new file mode 100644 index 0000000000..e9ea4b2f99 Binary files /dev/null and b/app_python/docs/screenshots/lab07-shots/grafana dashboard.png differ diff --git a/app_python/docs/screenshots/lab07-shots/grafana-app-name.png b/app_python/docs/screenshots/lab07-shots/grafana-app-name.png new file mode 100644 index 0000000000..fd72e51ce9 Binary files /dev/null and b/app_python/docs/screenshots/lab07-shots/grafana-app-name.png differ diff --git a/app_python/docs/screenshots/lab07-shots/grafana-error.png b/app_python/docs/screenshots/lab07-shots/grafana-error.png new file mode 100644 index 0000000000..0dba1e1844 Binary files /dev/null and b/app_python/docs/screenshots/lab07-shots/grafana-error.png differ diff --git a/app_python/docs/screenshots/lab07-shots/grafana_get.png b/app_python/docs/screenshots/lab07-shots/grafana_get.png new file mode 100644 index 0000000000..01553d407a Binary files /dev/null and b/app_python/docs/screenshots/lab07-shots/grafana_get.png differ diff --git a/app_python/docs/screenshots/lab07-shots/grafana_login.png b/app_python/docs/screenshots/lab07-shots/grafana_login.png new file mode 100644 index 0000000000..65e92615cf Binary files /dev/null and b/app_python/docs/screenshots/lab07-shots/grafana_login.png differ diff --git a/app_python/docs/screenshots/lab07-shots/grafana_logs_3_containers.png b/app_python/docs/screenshots/lab07-shots/grafana_logs_3_containers.png new file mode 100644 index 0000000000..2ca33c387f Binary files /dev/null and b/app_python/docs/screenshots/lab07-shots/grafana_logs_3_containers.png differ diff --git a/app_python/docs/screenshots/lab07-shots/healthy services.png b/app_python/docs/screenshots/lab07-shots/healthy services.png new file mode 100644 index 0000000000..efabf016f3 Binary files /dev/null and b/app_python/docs/screenshots/lab07-shots/healthy services.png differ diff --git a/app_python/docs/screenshots/lab07-shots/logs from the app.png b/app_python/docs/screenshots/lab07-shots/logs from the app.png new file mode 100644 index 0000000000..c4048b4b63 Binary files /dev/null and b/app_python/docs/screenshots/lab07-shots/logs from the app.png differ diff --git a/app_python/docs/screenshots/lab08-shots/dashboard1.png b/app_python/docs/screenshots/lab08-shots/dashboard1.png new file mode 100644 index 0000000000..e94922775b Binary files /dev/null and b/app_python/docs/screenshots/lab08-shots/dashboard1.png differ diff --git a/app_python/docs/screenshots/lab08-shots/dashboard2.png b/app_python/docs/screenshots/lab08-shots/dashboard2.png new file mode 100644 index 0000000000..d1f8714c6f Binary files /dev/null and b/app_python/docs/screenshots/lab08-shots/dashboard2.png differ diff --git a/app_python/docs/screenshots/lab08-shots/health statuses.png b/app_python/docs/screenshots/lab08-shots/health statuses.png new file mode 100644 index 0000000000..cf89eeb949 Binary files /dev/null and b/app_python/docs/screenshots/lab08-shots/health statuses.png differ diff --git a/app_python/docs/screenshots/lab08-shots/metrics for app logs.png b/app_python/docs/screenshots/lab08-shots/metrics for app logs.png new file mode 100644 index 0000000000..2c6998a0e0 Binary files /dev/null and b/app_python/docs/screenshots/lab08-shots/metrics for app logs.png differ diff --git a/app_python/docs/screenshots/lab08-shots/persistency.png b/app_python/docs/screenshots/lab08-shots/persistency.png new file mode 100644 index 0000000000..5e7459e607 Binary files /dev/null and b/app_python/docs/screenshots/lab08-shots/persistency.png differ diff --git a/app_python/docs/screenshots/lab08-shots/prometheous targets.png b/app_python/docs/screenshots/lab08-shots/prometheous targets.png new file mode 100644 index 0000000000..6963da43ce Binary files /dev/null and b/app_python/docs/screenshots/lab08-shots/prometheous targets.png differ diff --git a/app_python/docs/screenshots/lab08-shots/successful query.png b/app_python/docs/screenshots/lab08-shots/successful query.png new file mode 100644 index 0000000000..bc76a157c7 Binary files /dev/null and b/app_python/docs/screenshots/lab08-shots/successful query.png differ diff --git a/app_python/docs/screenshots/lab09-shots/curl app .png b/app_python/docs/screenshots/lab09-shots/curl app .png new file mode 100644 index 0000000000..8ec4de04f6 Binary files /dev/null and b/app_python/docs/screenshots/lab09-shots/curl app .png differ diff --git a/app_python/docs/screenshots/lab09-shots/rollout.png b/app_python/docs/screenshots/lab09-shots/rollout.png new file mode 100644 index 0000000000..866425dd76 Binary files /dev/null and b/app_python/docs/screenshots/lab09-shots/rollout.png differ diff --git a/app_python/docs/screenshots/lab09-shots/scaling.png b/app_python/docs/screenshots/lab09-shots/scaling.png new file mode 100644 index 0000000000..e74aaa0833 Binary files /dev/null and b/app_python/docs/screenshots/lab09-shots/scaling.png differ diff --git a/app_python/docs/screenshots/lab10-shots/app-working.png b/app_python/docs/screenshots/lab10-shots/app-working.png new file mode 100644 index 0000000000..47bab43c9f Binary files /dev/null and b/app_python/docs/screenshots/lab10-shots/app-working.png differ diff --git a/app_python/docs/screenshots/lab12-shots/counter.png b/app_python/docs/screenshots/lab12-shots/counter.png new file mode 100644 index 0000000000..e83a4ff5b8 Binary files /dev/null and b/app_python/docs/screenshots/lab12-shots/counter.png differ diff --git a/app_python/docs/screenshots/lab13-shots/application.png b/app_python/docs/screenshots/lab13-shots/application.png new file mode 100644 index 0000000000..ba2f7f8e21 Binary files /dev/null and b/app_python/docs/screenshots/lab13-shots/application.png differ diff --git a/app_python/docs/screenshots/lab13-shots/details.png b/app_python/docs/screenshots/lab13-shots/details.png new file mode 100644 index 0000000000..a0341d0c5b Binary files /dev/null and b/app_python/docs/screenshots/lab13-shots/details.png differ diff --git a/app_python/docs/screenshots/lab13-shots/drift.png b/app_python/docs/screenshots/lab13-shots/drift.png new file mode 100644 index 0000000000..c98c4fea1c Binary files /dev/null and b/app_python/docs/screenshots/lab13-shots/drift.png differ diff --git a/app_python/docs/screenshots/lab13-shots/sync status.png b/app_python/docs/screenshots/lab13-shots/sync status.png new file mode 100644 index 0000000000..705de1d582 Binary files /dev/null and b/app_python/docs/screenshots/lab13-shots/sync status.png differ diff --git a/app_python/docs/screenshots/lab13-shots/sync.png b/app_python/docs/screenshots/lab13-shots/sync.png new file mode 100644 index 0000000000..0720e0396c Binary files /dev/null and b/app_python/docs/screenshots/lab13-shots/sync.png differ diff --git a/app_python/docs/screenshots/lab14-shots/argo-dashboard-access.png b/app_python/docs/screenshots/lab14-shots/argo-dashboard-access.png new file mode 100644 index 0000000000..93cb0f496d Binary files /dev/null and b/app_python/docs/screenshots/lab14-shots/argo-dashboard-access.png differ diff --git a/app_python/docs/screenshots/lab14-shots/bg-2.png b/app_python/docs/screenshots/lab14-shots/bg-2.png new file mode 100644 index 0000000000..0d1e97d457 Binary files /dev/null and b/app_python/docs/screenshots/lab14-shots/bg-2.png differ diff --git a/app_python/docs/screenshots/lab14-shots/bg-3.png b/app_python/docs/screenshots/lab14-shots/bg-3.png new file mode 100644 index 0000000000..bea1b39d10 Binary files /dev/null and b/app_python/docs/screenshots/lab14-shots/bg-3.png differ diff --git a/app_python/docs/screenshots/lab14-shots/bg-4.png b/app_python/docs/screenshots/lab14-shots/bg-4.png new file mode 100644 index 0000000000..196ef487ab Binary files /dev/null and b/app_python/docs/screenshots/lab14-shots/bg-4.png differ diff --git a/app_python/docs/screenshots/lab14-shots/bg-5.png b/app_python/docs/screenshots/lab14-shots/bg-5.png new file mode 100644 index 0000000000..275e4f4796 Binary files /dev/null and b/app_python/docs/screenshots/lab14-shots/bg-5.png differ diff --git a/app_python/docs/screenshots/lab14-shots/blue-green-1.png b/app_python/docs/screenshots/lab14-shots/blue-green-1.png new file mode 100644 index 0000000000..15936932ff Binary files /dev/null and b/app_python/docs/screenshots/lab14-shots/blue-green-1.png differ diff --git a/app_python/docs/screenshots/lab14-shots/canary-abort.png b/app_python/docs/screenshots/lab14-shots/canary-abort.png new file mode 100644 index 0000000000..dd031144fd Binary files /dev/null and b/app_python/docs/screenshots/lab14-shots/canary-abort.png differ diff --git a/app_python/docs/screenshots/lab14-shots/canary-prom-1.png b/app_python/docs/screenshots/lab14-shots/canary-prom-1.png new file mode 100644 index 0000000000..73395076d0 Binary files /dev/null and b/app_python/docs/screenshots/lab14-shots/canary-prom-1.png differ diff --git a/app_python/docs/screenshots/lab14-shots/canary-prom-2.png b/app_python/docs/screenshots/lab14-shots/canary-prom-2.png new file mode 100644 index 0000000000..bb11cd91cc Binary files /dev/null and b/app_python/docs/screenshots/lab14-shots/canary-prom-2.png differ diff --git a/app_python/docs/screenshots/lab14-shots/canary-prom-3.png b/app_python/docs/screenshots/lab14-shots/canary-prom-3.png new file mode 100644 index 0000000000..98be269459 Binary files /dev/null and b/app_python/docs/screenshots/lab14-shots/canary-prom-3.png differ diff --git a/app_python/docs/screenshots/lab15-shots/pers_test.png b/app_python/docs/screenshots/lab15-shots/pers_test.png new file mode 100644 index 0000000000..f142fe13fa Binary files /dev/null and b/app_python/docs/screenshots/lab15-shots/pers_test.png differ diff --git a/app_python/docs/screenshots/lab15-shots/visits-diff.png b/app_python/docs/screenshots/lab15-shots/visits-diff.png new file mode 100644 index 0000000000..ddcbd746e0 Binary files /dev/null and b/app_python/docs/screenshots/lab15-shots/visits-diff.png differ diff --git a/app_python/docs/screenshots/lab16-shots/Screenshot 2026-05-09 at 21.24.02.png b/app_python/docs/screenshots/lab16-shots/Screenshot 2026-05-09 at 21.24.02.png new file mode 100644 index 0000000000..3dd0a8efe7 Binary files /dev/null and b/app_python/docs/screenshots/lab16-shots/Screenshot 2026-05-09 at 21.24.02.png differ diff --git a/app_python/docs/screenshots/lab16-shots/alert.png b/app_python/docs/screenshots/lab16-shots/alert.png new file mode 100644 index 0000000000..fde3f418b3 Binary files /dev/null and b/app_python/docs/screenshots/lab16-shots/alert.png differ diff --git a/app_python/docs/screenshots/lab16-shots/cpupod2.png b/app_python/docs/screenshots/lab16-shots/cpupod2.png new file mode 100644 index 0000000000..3d2ab981f6 Binary files /dev/null and b/app_python/docs/screenshots/lab16-shots/cpupod2.png differ diff --git a/app_python/docs/screenshots/lab16-shots/curl.png b/app_python/docs/screenshots/lab16-shots/curl.png new file mode 100644 index 0000000000..94cea81937 Binary files /dev/null and b/app_python/docs/screenshots/lab16-shots/curl.png differ diff --git a/app_python/docs/screenshots/lab16-shots/memorypod2.png b/app_python/docs/screenshots/lab16-shots/memorypod2.png new file mode 100644 index 0000000000..7e83d87b1f Binary files /dev/null and b/app_python/docs/screenshots/lab16-shots/memorypod2.png differ diff --git a/app_python/docs/screenshots/lab16-shots/namespace usage.png b/app_python/docs/screenshots/lab16-shots/namespace usage.png new file mode 100644 index 0000000000..3b492e8e19 Binary files /dev/null and b/app_python/docs/screenshots/lab16-shots/namespace usage.png differ diff --git a/app_python/docs/screenshots/lab16-shots/network.png b/app_python/docs/screenshots/lab16-shots/network.png new file mode 100644 index 0000000000..ac0c61c561 Binary files /dev/null and b/app_python/docs/screenshots/lab16-shots/network.png differ diff --git a/app_python/docs/screenshots/lab16-shots/node cpu memory.png b/app_python/docs/screenshots/lab16-shots/node cpu memory.png new file mode 100644 index 0000000000..6b67c8c7d2 Binary files /dev/null and b/app_python/docs/screenshots/lab16-shots/node cpu memory.png differ diff --git a/app_python/docs/screenshots/lab16-shots/pod cpu, memory.png b/app_python/docs/screenshots/lab16-shots/pod cpu, memory.png new file mode 100644 index 0000000000..b48bf4e190 Binary files /dev/null and b/app_python/docs/screenshots/lab16-shots/pod cpu, memory.png differ diff --git a/app_python/docs/screenshots/lab16-shots/pods managed.png b/app_python/docs/screenshots/lab16-shots/pods managed.png new file mode 100644 index 0000000000..9920abeb46 Binary files /dev/null and b/app_python/docs/screenshots/lab16-shots/pods managed.png differ diff --git a/app_python/docs/screenshots/lab17-shots/dashboard.png b/app_python/docs/screenshots/lab17-shots/dashboard.png new file mode 100644 index 0000000000..46fb3d234c Binary files /dev/null and b/app_python/docs/screenshots/lab17-shots/dashboard.png differ diff --git a/app_python/docs/screenshots/lab17-shots/edge deployed.png b/app_python/docs/screenshots/lab17-shots/edge deployed.png new file mode 100644 index 0000000000..ddc26f2de3 Binary files /dev/null and b/app_python/docs/screenshots/lab17-shots/edge deployed.png differ diff --git a/app_python/docs/screenshots/lab17-shots/endpoints local.png b/app_python/docs/screenshots/lab17-shots/endpoints local.png new file mode 100644 index 0000000000..b7a9612d97 Binary files /dev/null and b/app_python/docs/screenshots/lab17-shots/endpoints local.png differ diff --git a/app_python/docs/screenshots/lab17-shots/logs.png b/app_python/docs/screenshots/lab17-shots/logs.png new file mode 100644 index 0000000000..ca44c916d5 Binary files /dev/null and b/app_python/docs/screenshots/lab17-shots/logs.png differ diff --git a/app_python/docs/screenshots/lab17-shots/metrics.png b/app_python/docs/screenshots/lab17-shots/metrics.png new file mode 100644 index 0000000000..5646d44d46 Binary files /dev/null and b/app_python/docs/screenshots/lab17-shots/metrics.png differ diff --git a/app_python/docs/screenshots/lab17-shots/persistance.png b/app_python/docs/screenshots/lab17-shots/persistance.png new file mode 100644 index 0000000000..d437a22939 Binary files /dev/null and b/app_python/docs/screenshots/lab17-shots/persistance.png differ diff --git a/app_python/docs/screenshots/lab17-shots/secrets.png b/app_python/docs/screenshots/lab17-shots/secrets.png new file mode 100644 index 0000000000..a0d01bea32 Binary files /dev/null and b/app_python/docs/screenshots/lab17-shots/secrets.png differ diff --git a/app_python/k8s/ARGOCD.md b/app_python/k8s/ARGOCD.md new file mode 100644 index 0000000000..67c2551dda --- /dev/null +++ b/app_python/k8s/ARGOCD.md @@ -0,0 +1,214 @@ +# Documentation + +## ArgoCD Setup + +### Installation verification + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm install argocd argo/argo-cd --namespace argocd +NAME: argocd +LAST DEPLOYED: Thu Apr 23 18:37:11 2026 +NAMESPACE: argocd +STATUS: deployed +REVISION: 1 +DESCRIPTION: Install complete +TEST SUITE: None +NOTES: +In order to access the server UI you have the following options: + +1. kubectl port-forward service/argocd-server -n argocd 8080:443 + + and then open the browser on http://localhost:8080 and accept the certificate + +2. enable ingress in the values file `server.ingress.enabled` and either + - Add the annotation for ssl passthrough: https://argo-cd.readthedocs.io/en/stable/operator-manual/ingress/#option-1-ssl-passthrough + - Set the `configs.params."server.insecure"` in the values file and terminate SSL at your ingress: https://argo-cd.readthedocs.io/en/stable/operator-manual/ingress/#option-2-multiple-ingress-objects-and-hosts + + +After reaching the UI the first time you can login with username: admin and the random password generated during the installation. You can find the password by running: + +kubectl -n argocd get secret argocd-initial-admin-secret -o jsonpath="{.data.password}" | base64 -d + +(You should delete the initial secret afterwards as suggested by the Getting Started Guide: https://argo-cd.readthedocs.io/en/stable/getting_started/#4-login-using-the-cli) +(devops) fountainer@Veronicas-MacBook-Air app_python % helm list -n argocd +NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION +argocd argocd 1 2026-04-23 18:37:11.582773 +0300 MSK deployed argo-cd-9.5.4 v3.3.8 +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % argocd version +argocd: v3.3.8+7ae7d2c.dirty + BuildDate: 2026-04-21T20:19:34Z + GitCommit: 7ae7d2cc723f5408b080a31263e705198af08613 + GitTreeState: dirty + GitTag: v3.3.8 + GoVersion: go1.26.2 + Compiler: gc + Platform: darwin/arm64 +argocd-server: v3.3.8 + BuildDate: 2026-04-21T17:19:47Z + GitCommit: 7ae7d2cc723f5408b080a31263e705198af08613 + GitTreeState: clean + GitTag: v3.3.8 + GoVersion: go1.25.5 + Compiler: gc + Platform: linux/arm64 + Kustomize Version: v5.8.1 2026-02-09T16:15:27Z + Helm Version: v3.19.4+g7cfb6e4 + Kubectl Version: v0.34.0 + Jsonnet Version: v0.21.0 + ``` + +### UI access method + +Accessed ArgoCD UI via kubectl port-forward to localhost and logged in through the browser using the admin credentials and a previously created password. + +### CLI configuration + +Installed the argocd CLI with Homebrew and connected to the server using argocd login localhost:8080 --insecure. + +## Application Configuration + +### Application manifests + +Created an ArgoCD Application manifest defining the app name, project, source repository, and destination cluster settings. + +### Source and destination configuration + +Configured the application to pull from the Git repository (Helm chart path) and deploy to the in-cluster Kubernetes API in the default namespace. + +### Values file selection + +Specified values.yaml as the Helm values file to control application configuration during deployment. To test, I changed the number of replicas from 1 to 3. + +## Multi-Environment + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n dev +NAME READY STATUS RESTARTS AGE +python-app-dev-app-python-59fdf484d5-g97xn 1/1 Running 1 (22m ago) 22m +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n prod +NAME READY STATUS RESTARTS AGE +python-app-prod-app-python-9dc9c6fbc-n8mtr 1/1 Running 0 4m14s +python-app-prod-app-python-9dc9c6fbc-sqflv 1/1 Running 0 21m +python-app-prod-app-python-9dc9c6fbc-xfvbj 1/1 Running 0 4m14s +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % argocd app list +NAME CLUSTER NAMESPACE PROJECT STATUS HEALTH SYNCPOLICY CONDITIONS REPO PATH TARGET +argocd/my-app https://kubernetes.default.svc default default Synced Healthy Manual https://github.com/ffountainer/DevOps-Core-Course app_python/k8s/app_python lab13 +argocd/python-app-dev https://kubernetes.default.svc dev default Synced Healthy Auto-Prune https://github.com/ffountainer/DevOps-Core-Course app_python/k8s/app_python lab13 +argocd/python-app-prod https://kubernetes.default.svc prod default Synced Healthy Manual https://github.com/ffountainer/DevOps-Core-Course app_python/k8s/app_python lab13 +``` + +### Dev vs Prod configuration differences + +Dev uses smaller resource limits and fewer replicas for faster iteration, while prod uses higher replica count and stricter resource limits for stability and performance. + +### Sync policy differences and rationale + +Dev is configured with automated sync including self-heal and prune for continuous deployment, while prod uses manual sync to ensure controlled and reviewed releases. + +### Namespace separation + +Dev and prod are deployed into separate namespaces to isolate environments, prevent interference, and ensure independent lifecycle management. + +## Self-Healing Evidence + +### Manual scale test with before/after + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get deploy -n dev +NAME READY UP-TO-DATE AVAILABLE AGE +python-app-dev-app-python 1/1 1 1 30m +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl scale deployment python-app-dev-app-python -n dev --replicas=5 +deployment.apps/python-app-dev-app-python scaled +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get deploy -n dev +NAME READY UP-TO-DATE AVAILABLE AGE +python-app-dev-app-python 1/1 1 1 31m +``` + +### Pod deletion test + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n dev +NAME READY STATUS RESTARTS AGE +python-app-dev-app-python-59fdf484d5-g97xn 1/1 Running 1 (31m ago) 32m +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl delete pod python-app-dev-app-python-59fdf484d5-g97xn -n dev +pod "python-app-dev-app-python-59fdf484d5-g97xn" deleted +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n dev +NAME READY STATUS RESTARTS AGE +python-app-dev-app-python-59fdf484d5-249xv 0/1 Running 0 15s +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n dev +NAME READY STATUS RESTARTS AGE +python-app-dev-app-python-59fdf484d5-249xv 1/1 Running 0 37s +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % +``` + +### Configuration drift test + +Here you can see the drift +![](./../docs/screenshots/lab13-shots/drift.png) + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % argocd app get python-app-dev +Name: argocd/python-app-dev +Project: default +Server: https://kubernetes.default.svc +Namespace: dev +URL: https://argocd.example.com/applications/python-app-dev +Source: +- Repo: https://github.com/ffountainer/DevOps-Core-Course + Target: lab13 + Path: app_python/k8s/app_python + Helm Values: values-dev.yaml +SyncWindow: Sync Allowed +Sync Policy: Automated (Prune) +Sync Status: Synced to lab13 (27593a9) +Health Status: Healthy + +GROUP KIND NAMESPACE NAME STATUS HEALTH HOOK MESSAGE +batch Job dev python-app-dev-app-python-pre-install Succeeded PreSync Reached expected number of succeeded pods + Secret dev app-credentials Synced secret/app-credentials configured + ConfigMap dev python-app-dev-app-python-env Synced configmap/python-app-dev-app-python-env unchanged + ConfigMap dev python-app-dev-app-python-config Synced configmap/python-app-dev-app-python-config unchanged + PersistentVolumeClaim dev python-app-dev-app-python-data Synced Healthy persistentvolumeclaim/python-app-dev-app-python-data unchanged + Service dev python-app-dev-app-python-service Synced Healthy service/python-app-dev-app-python-service unchanged +apps Deployment dev python-app-dev-app-python Synced Healthy deployment.apps/python-app-dev-app-python configured +batch Job dev python-app-dev-app-python-post-install Succeeded PostSync Reached expected number of succeeded pods +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl scale deployment python-app-dev-app-python -n dev --replicas=2 +deployment.apps/python-app-dev-app-python scaled +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get deploy -n dev +NAME READY UP-TO-DATE AVAILABLE AGE +python-app-dev-app-python 1/1 1 1 52m +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl describe deployment python-app-dev-app-python -n dev | grep Replicas +Replicas: 1 desired | 1 updated | 1 total | 1 available | 0 unavailable + Available True MinimumReplicasAvailable +``` + +### Explanation of behaviors + +- Explain when ArgoCD syncs vs when Kubernetes heals + +ArgoCD references changes in git, and Kubernetes monitors the cluster (it will heal if the pod crushes, etc) + +- What triggers ArgoCD sync? + +git repo changes, manual sync triggered, auto-sync enabled, drift detected + self-heal enabled + +- What is the sync interval? + +the default sync is every 3 minutes + +## Screenshots + +### ArgoCD UI showing the applications + +![](./../docs/screenshots/lab13-shots/application.png) + +### Sync status + +![](./../docs/screenshots/lab13-shots/sync%20status.png) +![](./../docs/screenshots/lab13-shots/sync.png) + +### Application details view + +![](./../docs/screenshots/lab13-shots/details.png) \ No newline at end of file diff --git a/app_python/k8s/CONFIGMAPS.md b/app_python/k8s/CONFIGMAPS.md new file mode 100644 index 0000000000..f79a158422 --- /dev/null +++ b/app_python/k8s/CONFIGMAPS.md @@ -0,0 +1,141 @@ +# Documentation + +## Application Changes + +### Description of visits counter implementation + +visits counter is a global integer that increases every time / endpoint is called. it writes the value into a file (visits) so it can survive pod restarts via pvc. + +### New endpoint documentation + +/visits returns the current stored counter value from data/visits file + +### Local testing evidence with Docker + +Here you can see the counter value persistence across restarts. +![](./../docs/screenshots/lab12-shots/counter.png) + +## ConfigMap Implementation + +### ConfigMap template structure + +Helm ConfigMap loads a local config.json file via .Files.Get, so the whole json is injected into the cluster as one config object + +### config.json content + +it contains basic app metadata like name, environment, and feature flags (debug, metrics) plus log level settings + +### How ConfigMap is mounted as file + +the ConfigMap is mounted as a volume at /config, so inside the container we can read /config/config.json as a normal file. + +### How ConfigMap provides environment variables + +by using envFrom: configMapRef to inject keys like APP_NAME, APP_ENV, and LOG_LEVEL directly as environment variables. + + +### Verification outputs + +- File content inside pod (cat /config/config.json) + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec mysecretrelease-app-python-696f97599c-5llgh -- cat /config/config.json +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +{ + "app_name": "my-app", + "environment": "dev", + "feature_flags": { + "debug": true, + "metrics": true + }, + "settings": { + "log_level": "info" + } +}% +``` + +- Environment variables in pod + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec mysecretrelease-app-python-696f97599c-5llgh -- printenv | grep APP_ +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +APP_ENV=dev +APP_NAME=my-app +MYSECRETRELEASE_APP_PYTHON_SERVICE_SERVICE_PORT=80 +MYSECRETRELEASE_APP_PYTHON_SERVICE_PORT_80_TCP=tcp://10.103.123.105:80 +MYSECRETRELEASE_APP_PYTHON_SERVICE_PORT_80_TCP_PROTO=tcp +MYSECRETRELEASE_APP_PYTHON_SERVICE_PORT_80_TCP_PORT=80 +MYSECRETRELEASE_APP_PYTHON_SERVICE_SERVICE_HOST=10.103.123.105 +MYSECRETRELEASE_APP_PYTHON_SERVICE_PORT=tcp://10.103.123.105:80 +MYSECRETRELEASE_APP_PYTHON_SERVICE_PORT_80_TCP_ADDR=10.103.123.105 +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec mysecretrelease-app-python-696f97599c-5llgh -- printenv | grep LOG_LEVEL +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +LOG_LEVEL=info +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` + + +## Persistent Volume + +### PVC configuration explanation + +PVC requests a small storage size (100Mi) and creates a persistent volume that is mounted into the pod at /app/data to store the visits file. + +### Access modes and storage class discussion + +ReadWriteOnce is used because only one pod needs to write to the volume, and storageClass is optional so it uses the cluster default. + +### Volume mount configuration + +the volume is mounted into the container at /app/data, and the app writes visits file there so data stays after pod restarts/recreations + +### Persistence test evidence: + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec mysecretrelease-app-python-7b6579656c-z6r7b -- cat /app/data/visits +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +22% +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl delete pod mysecretrelease-app-python-7b6579656c-z6r7b +pod "mysecretrelease-app-python-7b6579656c-z6r7b" deleted +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pod +NAME READY STATUS RESTARTS AGE +mysecretrelease-app-python-7b6579656c-b2tzf 2/2 Running 0 60s +vault-0 1/1 Running 3 (84m ago) 8d +vault-agent-injector-848dd747d7-qvgl2 1/1 Running 3 (85m ago) 8d +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec mysecretrelease-app-python-7b6579656c-b2tzf -- cat /app/data/visits +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +22% +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` + +## ConfigMap vs Secret + +### When to use ConfigMap + +ConfigMap is used for non-sensitive configuration like app name, environment, log level, and feature flags. + +### When to use Secret + +secret is used for sensitive data like username, password, or anything that should not be visible in plain text + +### Key differences + +configMap is plain text and not encrypted, while Secret is base64 encoded and used for sensitive data. + +## Additional Outputs: + +### kubectl get configmap,pvc output + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get configmap,pvc +NAME DATA AGE +configmap/kube-root-ca.crt 1 22d +configmap/mysecretrelease-app-python-config 1 7m2s +configmap/mysecretrelease-app-python-env 3 7m2s + +NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS VOLUMEATTRIBUTESCLASS AGE +persistentvolumeclaim/mysecretrelease-app-python-data Bound pvc-42d4685f-8463-4434-8959-0bacd5d972b6 100Mi RWO standard 7m2s +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` + + diff --git a/app_python/k8s/HELM.md b/app_python/k8s/HELM.md new file mode 100644 index 0000000000..e3f80de3ab --- /dev/null +++ b/app_python/k8s/HELM.md @@ -0,0 +1,499 @@ +# Documentation + +## Chart Overview + +### Chart structure explanation + +- the chart has templates/ for kubectl manifests, values.yaml for default settings, and _helpers.tpl for reusable template functions. Hooks are in templates/hooks/ for pre and post-install jobs + +### Key template files and their purpose + +- deployment.yaml defines the app pods and containers +- service.yaml exposes them, and hooks run tasks before or after install +- helpers in _helpers.tpl build names, labels, and selectors consistently, and then can be reused in different config files + +### Values organization strategy + +- values.yaml has defaults, while values-dev.yaml and values-prod.yaml override settings for different environments. +This keeps environment configs separate and easy to manage. + +## Configuration Guide + +### Important values and their purpose + +- replicaCount sets pod number, resources manage CPU/memory, service.type controls what role will the service have (NodePort vs LoadBalancer, etc). LivenessProbe and readinessProbe check pod health. + +### How to customize for different environments + +- you can use values-dev.yaml for dev with 1 replica and NodePort, values-prod.yaml for prod with more replicas and LoadBalancer. and you can also override values on install with --set + +### Example installations with different configurations + +- dev + +```bash +helm install myapp-dev k8s/app_python -f k8s/app_python/values-dev.yaml +``` + +- prod + +```bash +helm install myapp-prod k8s/app_python -f k8s/app_python/values-prod.yaml +``` + +## Hook Implementation + +### What hooks you implemented and why + +- I implemented a pre-install job for setup tasks and a post-install job for validation, to simulate real lifecycle tasks + +### Hook execution order and weights + +- Pre-install has weight -5 to run early, post-install has weight 5 to run after deployment. + +### Deletion policies explanation + +- both hooks have hook-succeeded policy so they auto-delete after finishing successfully + +## Installation Evidence + +### Terminal output showing Helm installation and version (should be 4.x) + +```bash +==> Fetching downloads for: helm +✔︎ Bottle Manifest helm (4.1.3) Downloaded 7.4KB/ 7.4KB +✔︎ Bottle helm (4.1.3) Downloaded 18.1MB/ 18.1MB +==> Pouring helm--4.1.3.arm64_tahoe.bottle.tar.gz +🍺 /opt/homebrew/Cellar/helm/4.1.3: 69 files, 61.3MB +==> Running `brew cleanup helm`... +Disable this behaviour by setting `HOMEBREW_NO_INSTALL_CLEANUP=1`. +Hide these hints with `HOMEBREW_NO_ENV_HINTS=1` (see `man brew`). +==> Caveats +zsh completions have been installed to: + /opt/homebrew/share/zsh/site-functions +``` +### Output of exploring a public chart (e.g., helm show chart prometheus-community/prometheus) + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm show chart prometheus-community/prometheus +annotations: + artifacthub.io/license: Apache-2.0 + artifacthub.io/links: | + - name: Chart Source + url: https://github.com/prometheus-community/helm-charts + - name: Upstream Project + url: https://github.com/prometheus/prometheus +apiVersion: v2 +appVersion: v3.11.0 +dependencies: +- condition: alertmanager.enabled + name: alertmanager + repository: https://prometheus-community.github.io/helm-charts + version: 1.34.* +- condition: kube-state-metrics.enabled + name: kube-state-metrics + repository: https://prometheus-community.github.io/helm-charts + version: 7.2.* +- condition: prometheus-node-exporter.enabled + name: prometheus-node-exporter + repository: https://prometheus-community.github.io/helm-charts + version: 4.52.* +- condition: prometheus-pushgateway.enabled + name: prometheus-pushgateway + repository: https://prometheus-community.github.io/helm-charts + version: 3.6.* +description: Prometheus is a monitoring system and time series database. +home: https://prometheus.io/ +icon: https://raw.githubusercontent.com/prometheus/prometheus.github.io/master/assets/prometheus_logo-cb55bb5c346.png +keywords: +- monitoring +- prometheus +kubeVersion: '>=1.19.0-0' +maintainers: +- email: gianrubio@gmail.com + name: gianrubio + url: https://github.com/gianrubio +- email: zanhsieh@gmail.com + name: zanhsieh + url: https://github.com/zanhsieh +- email: miroslav.hadzhiev@gmail.com + name: Xtigyro + url: https://github.com/Xtigyro +- email: naseem@transit.app + name: naseemkullah + url: https://github.com/naseemkullah +- email: rootsandtrees@posteo.de + name: zeritti + url: https://github.com/zeritti +name: prometheus +sources: +- https://github.com/prometheus/alertmanager +- https://github.com/prometheus/prometheus +- https://github.com/prometheus/pushgateway +- https://github.com/prometheus/node_exporter +- https://github.com/kubernetes/kube-state-metrics +type: application +version: 28.15.0 +``` + +### helm list output + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % helm list +NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION +my-python-app-dev default 1 2026-04-02 22:00:55.999506 +0300 MSK deployed app_python-0.1.0 1.0 +my-python-app-prod default 1 2026-04-02 22:12:24.157572 +0300 MSK deployed app_python-0.1.0 1.0 +myrelease default 1 2026-04-02 22:40:56.562009 +0300 MSK deployed app_python-0.1.0 1.0 +``` + +### kubectl get all showing deployed resources + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get all +NAME READY STATUS RESTARTS AGE +pod/my-python-app-dev-app-python-7d7f699d85-kklth 1/1 Running 0 43m +pod/my-python-app-prod-app-python-74c5b97dd5-4mjjr 0/1 Running 0 31m +pod/my-python-app-prod-app-python-74c5b97dd5-6pm7l 0/1 Running 0 31m +pod/my-python-app-prod-app-python-74c5b97dd5-75dvc 0/1 Running 0 31m +pod/my-python-app-prod-app-python-74c5b97dd5-9v58s 0/1 Running 0 31m +pod/my-python-app-prod-app-python-74c5b97dd5-xktsb 0/1 Running 0 31m +pod/myrelease-app-python-569fb4b645-6v9dt 1/1 Running 0 2m32s +pod/myrelease-app-python-569fb4b645-8ws5n 1/1 Running 0 2m32s +pod/myrelease-app-python-569fb4b645-glt5r 1/1 Running 0 2m32s +pod/myrelease-app-python-569fb4b645-qtg4j 1/1 Running 0 2m32s +pod/myrelease-app-python-569fb4b645-rgppk 1/1 Running 0 2m32s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/kubernetes ClusterIP 10.96.0.1 443/TCP 8d +service/my-python-app-dev-app-python-service NodePort 10.104.238.26 80:30007/TCP 43m +service/my-python-app-prod-app-python-service LoadBalancer 10.101.156.227 80:30008/TCP 31m +service/myrelease-app-python-service NodePort 10.107.17.3 80:30009/TCP 2m32s + +NAME READY UP-TO-DATE AVAILABLE AGE +deployment.apps/my-python-app-dev-app-python 1/1 1 1 43m +deployment.apps/my-python-app-prod-app-python 0/5 5 0 31m +deployment.apps/myrelease-app-python 5/5 5 5 2m32s + +NAME DESIRED CURRENT READY AGE +replicaset.apps/my-python-app-dev-app-python-7d7f699d85 1 1 1 43m +replicaset.apps/my-python-app-prod-app-python-74c5b97dd5 5 5 0 31m +replicaset.apps/myrelease-app-python-569fb4b645 5 5 5 2m32s +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % +``` + +### Hook execution output (kubectl get jobs) + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get jobs -w +NAME STATUS COMPLETIONS DURATION AGE +myrelease-app-python-pre-install Running 0/1 0s +myrelease-app-python-pre-install Running 0/1 0s 0s +myrelease-app-python-pre-install Running 0/1 33s 33s +myrelease-app-python-pre-install Running 0/1 43s 43s +myrelease-app-python-pre-install SuccessCriteriaMet 0/1 44s 44s +myrelease-app-python-pre-install Complete 1/1 44s 44s +myrelease-app-python-pre-install Complete 1/1 44s 44s +myrelease-app-python-post-install Running 0/1 0s +myrelease-app-python-post-install Running 0/1 0s 0s +myrelease-app-python-post-install Running 0/1 5s 5s +myrelease-app-python-post-install Running 0/1 15s 15s +myrelease-app-python-post-install SuccessCriteriaMet 0/1 16s 16s +myrelease-app-python-post-install Complete 1/1 16s 16s +myrelease-app-python-post-install Complete 1/1 16s 16s +``` + +### Different environment deployments (dev vs prod) + +- Dev + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm install my-python-app-dev k8s/app_python -f k8s/app_python/values-dev.yaml +NAME: my-python-app-dev +LAST DEPLOYED: Thu Apr 2 22:00:55 2026 +NAMESPACE: default +STATUS: deployed +REVISION: 1 +DESCRIPTION: Install complete +TEST SUITE: None +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pods +NAME READY STATUS RESTARTS AGE +my-python-app-dev-app-python-7d7f699d85-kklth 1/1 Running 0 2m20s +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get svc +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +kubernetes ClusterIP 10.96.0.1 443/TCP 7d23h +my-python-app-dev-app-python-service NodePort 10.104.238.26 80:30007/TCP 2m27s +``` + +- Prod + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm install my-python-app-prod k8s/app_python -f k8s/app_python/values-prod.yaml +NAME: my-python-app-prod +LAST DEPLOYED: Thu Apr 2 22:12:24 2026 +NAMESPACE: default +STATUS: deployed +REVISION: 1 +DESCRIPTION: Install complete +TEST SUITE: None +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pod +NAME READY STATUS RESTARTS AGE +my-python-app-dev-app-python-7d7f699d85-kklth 1/1 Running 0 12m +my-python-app-prod-app-python-74c5b97dd5-4mjjr 0/1 Running 0 38s +my-python-app-prod-app-python-74c5b97dd5-6pm7l 0/1 Running 0 38s +my-python-app-prod-app-python-74c5b97dd5-75dvc 0/1 Running 0 38s +my-python-app-prod-app-python-74c5b97dd5-9v58s 0/1 Running 0 38s +my-python-app-prod-app-python-74c5b97dd5-xktsb 0/1 Running 0 38s +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get svc +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +kubernetes ClusterIP 10.96.0.1 443/TCP 7d23h +my-python-app-dev-app-python-service NodePort 10.104.238.26 80:30007/TCP 12m +my-python-app-prod-app-python-service LoadBalancer 10.101.156.227 80:30008/TCP 49s +``` + + +## Operations + +### Installation commands used + +```bash +helm install name-of-new-release k8s/app_python -f k8s/app_python/values-for-new-release.yaml +``` +### How to upgrade a release + +```bash +helm upgrade myrelease k8s/app_python -f k8s/app_python/values-prod.yaml +``` + +### How to rollback + +```bash +helm rollback myrelease 1 +``` + +### How to uninstall + +```bash +helm uninstall name-of-release +``` + +## Testing & Validation + +### helm lint output + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % helm lint app_python +==> Linting app_python +[INFO] Chart.yaml: icon is recommended + +1 chart(s) linted, 0 chart(s) failed +``` +### helm template verification + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm template app-python k8s/app_python +--- +# Source: app_python/templates/service.yaml +apiVersion: v1 +kind: Service +metadata: + name: app-python-app-python-service +spec: + type: NodePort + selector: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: app-python + ports: + - protocol: TCP + port: 80 + targetPort: 12345 + nodePort: 30007 +--- +# Source: app_python/templates/deployment.yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: app-python-app-python + labels: + helm.sh/chart: app_python-0.1.0 + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: app-python + app.kubernetes.io/version: "1.0" + app.kubernetes.io/managed-by: Helm +spec: + replicas: 5 + strategy: + type: RollingUpdate + rollingUpdate: + maxUnavailable: 1 + maxSurge: 1 + selector: + matchLabels: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: app-python + template: + metadata: + labels: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: app-python + spec: + containers: + - name: app-python + image: "fountainer/my-app:2026.03.26" + imagePullPolicy: IfNotPresent + ports: + - containerPort: 12345 + resources: + requests: + cpu: 100m + memory: 128Mi + limits: + cpu: 500m + memory: 256Mi + livenessProbe: + httpGet: + path: /health + port: 12345 + initialDelaySeconds: 10 + periodSeconds: 10 + timeoutSeconds: 5 + failureThreshold: 5 + readinessProbe: + httpGet: + path: /ready + port: 12345 + initialDelaySeconds: 5 + periodSeconds: 5 +``` + +### Dry-run output + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm install --dry-run --debug test-release k8s/app_python +level=WARN msg="--dry-run is deprecated and should be replaced with '--dry-run=client'" +level=DEBUG msg="Original chart version" version="" +level=DEBUG msg="Chart path" path=/Users/fountainer/uni/devops/DevOps-Core-Course/app_python/k8s/app_python +level=DEBUG msg="number of dependencies in the chart" chart=app_python dependencies=0 +NAME: test-release +LAST DEPLOYED: Thu Apr 2 21:46:17 2026 +NAMESPACE: default +STATUS: pending-install +REVISION: 1 +DESCRIPTION: Dry run complete +TEST SUITE: None +USER-SUPPLIED VALUES: +{} + +COMPUTED VALUES: +container: + port: 12345 +image: + pullPolicy: IfNotPresent + repository: fountainer/my-app + tag: 2026.03.26 +livenessProbe: + failureThreshold: 5 + initialDelaySeconds: 10 + path: /health + periodSeconds: 10 + timeoutSeconds: 5 +readinessProbe: + initialDelaySeconds: 5 + path: /ready + periodSeconds: 5 +replicaCount: 5 +resources: + limits: + cpu: 500m + memory: 256Mi + requests: + cpu: 100m + memory: 128Mi +service: + nodePort: 30007 + port: 80 + protocol: TCP + targetPort: 12345 + type: NodePort +strategy: + maxSurge: 1 + maxUnavailable: 1 + +HOOKS: +MANIFEST: +--- +# Source: app_python/templates/service.yaml +apiVersion: v1 +kind: Service +metadata: + name: test-release-app-python-service +spec: + type: NodePort + selector: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: test-release + ports: + - protocol: TCP + port: 80 + targetPort: 12345 + nodePort: 30007 +--- +# Source: app_python/templates/deployment.yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: test-release-app-python + labels: + helm.sh/chart: app_python-0.1.0 + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: test-release + app.kubernetes.io/version: "1.0" + app.kubernetes.io/managed-by: Helm +spec: + replicas: 5 + strategy: + type: RollingUpdate + rollingUpdate: + maxUnavailable: 1 + maxSurge: 1 + selector: + matchLabels: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: test-release + template: + metadata: + labels: + app.kubernetes.io/name: app-python + app.kubernetes.io/instance: test-release + spec: + containers: + - name: app-python + image: "fountainer/my-app:2026.03.26" + imagePullPolicy: IfNotPresent + ports: + - containerPort: 12345 + resources: + requests: + cpu: 100m + memory: 128Mi + limits: + cpu: 500m + memory: 256Mi + livenessProbe: + httpGet: + path: /health + port: 12345 + initialDelaySeconds: 10 + periodSeconds: 10 + timeoutSeconds: 5 + failureThreshold: 5 + readinessProbe: + httpGet: + path: /ready + port: 12345 + initialDelaySeconds: 5 + periodSeconds: 5 + +``` +### Application accessibility verification + +![](./../docs/screenshots/lab10-shots/app-working.png) \ No newline at end of file diff --git a/app_python/k8s/MONITORING.md b/app_python/k8s/MONITORING.md new file mode 100644 index 0000000000..b71aebd57e --- /dev/null +++ b/app_python/k8s/MONITORING.md @@ -0,0 +1,227 @@ +# Documentation + +## Stack Components + +### Descriptions in your own words + +- Prometheus Operator: it's a kubernates tool that allows you to automate prometheus deployment and management. it provides a set of custom resource definitions, and you can make your own configuration with those. + +- Prometheus: it's a tool for monitoring and alerting, it stores metrics as a series of timestampts. + +- Alertmanager: an instruments to manage alerts. when metrics reach invalid state, alertmanager will receive alerts, group and send them to asignees. you can configure when to silence alerts or start reaching out to the next person if the first one is not responding (it's an escalation), and create other custom settings. + +- Grafana: it is a dashboard for tracking the current state of the system by visualising logs and metrics. you can define alert rules there to see if the new metric value is out of the valid tresholds. + +- kube-state-metrics: it's a service that exposes metrics related to kubernates objects, they are created automatically and describe your pods current state. + +- node-exporter: it's an agent that exposes internal metrics for a node (like cpu, memory, etc), then prometheus can scrape those metrics. + +## Installation Evidence + +### kubectl get po,svc -n monitoring + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % helm repo add prometheus-community https://prometheus-community.github.io/helm-charts +"prometheus-community" already exists with the same configuration, skipping +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % helm repo update +Hang tight while we grab the latest from your chart repositories... +...Successfully got an update from the "hashicorp" chart repository +...Successfully got an update from the "argo" chart repository +...Successfully got an update from the "prometheus-community" chart repository +Update Complete. ⎈Happy Helming!⎈ +``` + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get po,svc -n monitoring +NAME READY STATUS RESTARTS AGE +pod/alertmanager-monitoring-kube-prometheus-alertmanager-0 2/2 Running 0 2m34s +pod/monitoring-grafana-bbc5c674-8cbd9 3/3 Running 0 2m56s +pod/monitoring-kube-prometheus-operator-54f68d65b4-99ck2 1/1 Running 0 2m56s +pod/monitoring-kube-state-metrics-5957bd45bc-5rpqr 1/1 Running 0 2m56s +pod/monitoring-prometheus-node-exporter-c8fg6 1/1 Running 0 2m57s +pod/prometheus-monitoring-kube-prometheus-prometheus-0 2/2 Running 0 2m34s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/alertmanager-operated ClusterIP None 9093/TCP,9094/TCP,9094/UDP 2m34s +service/monitoring-grafana ClusterIP 10.110.156.182 80/TCP 2m57s +service/monitoring-kube-prometheus-alertmanager ClusterIP 10.111.243.229 9093/TCP,8080/TCP 2m57s +service/monitoring-kube-prometheus-operator ClusterIP 10.99.16.80 443/TCP 2m57s +service/monitoring-kube-prometheus-prometheus ClusterIP 10.106.17.206 9090/TCP,8080/TCP 2m57s +service/monitoring-kube-state-metrics ClusterIP 10.102.26.186 8080/TCP 2m57s +service/monitoring-prometheus-node-exporter ClusterIP 10.100.205.92 9100/TCP 2m57s +service/prometheus-operated ClusterIP None 9090/TCP 2m34s +``` + +## Dashboard Answers + +### Pod Resources: CPU/memory usage of your StatefulSet + +Due to the pods and the app itself being very lightweight, CPU and memory usage never went higher than initially allocated resources (100m CPU and 128Mi memory). Even under high load (I used multiple loops with curl), the initial resources were enough. You will see more detailed usages info in the next question. + +Example for pod 2: + +![](./../docs/screenshots/lab16-shots/cpupod2.png) + +![](./../docs/screenshots/lab16-shots/memorypod2.png) + +### Namespace Analysis: Which pods use most/least CPU in default namespace? + +I decided to use Prometheus for evidence, since the resource usage was really low, and didn't show up properly in Grafana. + +curl I used (the first count is much bigger since I previously tested only with pod 2) + +![](./../docs/screenshots/lab16-shots/curl.png) + +usage + +![](./../docs/screenshots/lab16-shots/namespace%20usage.png) + +As we can see, all statefulset pods used roughly the same amount of CPU and memory resources. This is anticipated, because load balancing is used for routing traffic to different pods. + +### Node Metrics: Memory usage (% and MB), CPU cores + +CPU and Memory usage for the whole minikube node was: + +![](./../docs/screenshots/lab16-shots/node%20cpu%20memory.png) + +It is much higher than resources used in statefulset since the node contains all different namespaces in my minikube cluster. + +### Kubelet: How many pods/containers managed? + +16 pods and 41 containers + +![](./../docs/screenshots/lab16-shots/pods%20managed.png) + +### Network: Traffic for pods in default namespace + +![](./../docs/screenshots/lab16-shots/network.png) + +### Alerts: How many active alerts? Check Alertmanager UI + +![](./../docs/screenshots/lab16-shots/alert.png) + +## Init Containers: Implementation and proof of success + +I implemented two init container patterns. First one downloads a file with wget into a shared emptyDir volume and the main container successfully accessed it from /data/index.html. Second one uses a wait-for-service init container that continuously checks the nginx service with wget and only starts the main container after the service becomes reachable. + +### Init container + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 0/1 Init:0/1 0 2s +myapp-app-python-0 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-1 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-2 1/1 Running 3 (6h15m ago) 7d20h +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 0/1 PodInitializing 0 4s +myapp-app-python-0 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-1 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-2 1/1 Running 3 (6h15m ago) 7d20h +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 1/1 Running 0 5s +myapp-app-python-0 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-1 1/1 Running 3 (6h15m ago) 7d20h +myapp-app-python-2 1/1 Running 3 (6h15m ago) 7d20h +``` +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl logs init-download-pod -c init-download +Connecting to example.com (172.66.147.243:443) +wget: note: TLS certificate validation not implemented +saving to '/work-dir/index.html' +index.html 100% |********************************| 528 0:00:00 ETA +'/work-dir/index.html' saved +``` + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl exec init-download-pod -- cat /data/index.html +Defaulted container "main-app" out of: main-app, init-download (init) +Example Domain

Example Domain

This domain is for use in documentation examples without needing permission. Avoid use in operations.

Learn more

+``` + +### Waiting for service container + +```bash +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl apply -f waiting.yaml +pod/wait-service-pod created +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 1/1 Running 0 51m +myapp-app-python-0 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-1 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-2 1/1 Running 3 (7h6m ago) 7d21h +wait-service-pod 0/1 Init:0/1 0 22s +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl logs wait-service-pod -c wait-for-service +wget: bad address 'myservice.default.svc.cluster.local' +waiting for service +wget: bad address 'myservice.default.svc.cluster.local' +waiting for service +wget: bad address 'myservice.default.svc.cluster.local' +waiting for service +wget: bad address 'myservice.default.svc.cluster.local' +waiting for service +wget: bad address 'myservice.default.svc.cluster.local' +waiting for service +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl apply -f nginx.yaml +deployment.apps/myservice created +service/myservice created +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 1/1 Running 0 51m +myapp-app-python-0 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-1 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-2 1/1 Running 3 (7h6m ago) 7d21h +myservice-ffc6675d7-pmjfr 1/1 Running 0 3s +wait-service-pod 0/1 Init:0/1 0 55s +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 1/1 Running 0 51m +myapp-app-python-0 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-1 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-2 1/1 Running 3 (7h6m ago) 7d21h +myservice-ffc6675d7-pmjfr 1/1 Running 0 5s +wait-service-pod 0/1 PodInitializing 0 57s +(devops) fountainer@Veronicas-MacBook-Air templates % kubectl get pod +NAME READY STATUS RESTARTS AGE +init-download-pod 1/1 Running 0 51m +myapp-app-python-0 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-1 1/1 Running 3 (7h6m ago) 7d21h +myapp-app-python-2 1/1 Running 3 (7h6m ago) 7d21h +myservice-ffc6675d7-pmjfr 1/1 Running 0 7s +wait-service-pod 1/1 Running 0 59s +``` + +After service was discovered: + +```bash +waiting for service + + + +Welcome to nginx! + + + +

Welcome to nginx!

+

If you see this page, nginx is successfully installed and working. +Further configuration is required for the web server, reverse proxy, +API gateway, load balancer, content cache, or other features.

+ +

For online documentation and support please refer to +nginx.org.
+To engage with the community please visit +community.nginx.org.
+For enterprise grade support, professional services, additional +security features and capabilities please refer to +f5.com/nginx.

+ +

Thank you for using nginx.

+ + +``` \ No newline at end of file diff --git a/app_python/k8s/README.md b/app_python/k8s/README.md new file mode 100644 index 0000000000..20ea3e883d --- /dev/null +++ b/app_python/k8s/README.md @@ -0,0 +1,301 @@ +# Documentation + +## Architecture Overview + +### Diagram or description of your deployment architecture + +```mermaid +flowchart LR + +subgraph Kubernetes_Cluster["Minikube Kubernetes Cluster"] + + S[Service node port
port 80 -> nodePort 30007] + + subgraph Deployment["Deployment: my-app (5 replicas)"] + P1[Pod 1
app-python] + P2[Pod 2
app-python] + P3[Pod 3
app-python] + P4[Pod 4
app-python] + P5[Pod 5
app-python] + end + +end + +User[User / curl / browser] + +User -->|HTTP request
http://nodeIP:30007| S + +S -->|routes traffic via selector
app: my-app| P1 +S --> P2 +S --> P3 +S --> P4 +S --> P5 + +P1 -->|/health /ready /metrics| AppLogic[(Flask App)] +P2 --> AppLogic +P3 --> AppLogic +P4 --> AppLogic +P5 --> AppLogic + +``` + +### How many Pods, which Services, networking flow + +- I used 5 pods managed by a deployment and one NodePort service, where traffic goes from the service (port 80 / nodePort 30007) to the pods using the app: my-app label selector. + +### Resource allocation strategy + +- I defined small cpu and memory requests/limits (100m–500m cpu, 128Mi–256Mi memory) to keep the app stable and prevent it from using too many cluster resources. + +### Brief explanation of your chosen tool (minikube/kind) and why + +I used minikube because it’s easy to set up locally and lets me run a full kubernetes cluster on my machine, which is enough for testing deployments without needing a real cloud setup. + +## Manifest Files + +### Brief description of each manifest + +- Deployment: deployment.yml defines how my app runs in Kubernetes, including how many pods, which image to use, and how they are configured. + +- Service: service.yml exposes the app inside and outside the cluster by routing traffic to the pods created by the deployment. + +### Key configuration choices + +- Deployment: I set 3 replicas, added resource limits/requests, configured liveness and readiness probes, used labels for selection, and set a rolling update strategy + +- Service: I used NodePort type, matched the selector with app: my-app, set port 80 as the service port, and mapped it to container port 12345 with a fixed nodePort. + +### Why you chose specific values (replicas, resources, etc.) + +- Deployment: I used 3 replicas for basic availability, small cpu/memory values since the app is lightweight, and probes to make sure kubernetes can detect when the app is healthy and ready to serve traffic. + +- Service: I used NodePort so i can access the app locally with minikube, port 80 for convenience, targetPort 12345 to match the app, and a fixed nodePort (30007) to make testing easier. + +## Deployment Evidence + +### Successful cluster setup + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % minikube start + +😄 minikube v1.38.1 on Darwin 26.3 (arm64) +✨ Using the docker driver based on existing profile +👍 Starting "minikube" primary control-plane node in "minikube" cluster +🚜 Pulling base image v0.0.50 ... +🏃 Updating the running docker "minikube" container ... +🐳 Preparing Kubernetes v1.35.1 on Docker 29.2.1 ... +🔎 Verifying Kubernetes components... + ▪ Using image gcr.io/k8s-minikube/storage-provisioner:v5 +🌟 Enabled addons: default-storageclass, storage-provisioner + +❗ /Applications/Docker.app/Contents/Resources/bin/kubectl is version 1.32.2, which may have incompatibilities with Kubernetes 1.35.1. + ▪ Want kubectl v1.35.1? Try 'minikube kubectl -- get pods -A' +🏄 Done! kubectl is now configured to use "minikube" cluster and "default" namespace by default +``` +### Output of kubectl cluster-info and kubectl get nodes + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl cluster-info +Kubernetes control plane is running at https://127.0.0.1:51390 +CoreDNS is running at https://127.0.0.1:51390/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy + +To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'. +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get nodes +NAME STATUS ROLES AGE VERSION +minikube Ready control-plane 6h45m v1.35.1 +``` + +### kubectl get all output + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get all +NAME READY STATUS RESTARTS AGE +pod/my-app-deployment-6f67848dfb-kxbtv 1/1 Running 0 3m11s +pod/my-app-deployment-6f67848dfb-mjq8x 1/1 Running 0 3m11s +pod/my-app-deployment-6f67848dfb-vx95p 1/1 Running 0 3m11s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/kubernetes ClusterIP 10.96.0.1 443/TCP 6h58m + +NAME READY UP-TO-DATE AVAILABLE AGE +deployment.apps/my-app-deployment 3/3 3 3 3m11s + +NAME DESIRED CURRENT READY AGE +replicaset.apps/my-app-deployment-6f67848dfb 3 3 3 3m11s +``` +### kubectl get pods,svc with detailed view + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get pods,svc +NAME READY STATUS RESTARTS AGE +pod/my-app-deployment-6f67848dfb-kxbtv 1/1 Running 0 3m35s +pod/my-app-deployment-6f67848dfb-mjq8x 1/1 Running 0 3m35s +pod/my-app-deployment-6f67848dfb-vx95p 1/1 Running 0 3m35s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/kubernetes ClusterIP 10.96.0.1 443/TCP 6h59m +``` + +### kubectl describe deployment showing replicas and strategy + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get pods +NAME READY STATUS RESTARTS AGE +my-app-deployment-6f67848dfb-kxbtv 1/1 Running 0 29s +my-app-deployment-6f67848dfb-mjq8x 1/1 Running 0 29s +my-app-deployment-6f67848dfb-vx95p 1/1 Running 0 29s +``` +### Screenshot or curl output showing app working + +![](./../docs/screenshots/lab09-shots/curl%20app%20.png) + +### Service deployment + +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get services +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +kubernetes ClusterIP 10.96.0.1 443/TCP 38m +my-app-service NodePort 10.98.179.244 80:30007/TCP 41s +(devops) fountainer@Veronicas-MacBook-Air k8s % minikube service my-app-service +┌───────────┬────────────────┬─────────────┬───────────────────────────┐ +│ NAMESPACE │ NAME │ TARGET PORT │ URL │ +├───────────┼────────────────┼─────────────┼───────────────────────────┤ +│ default │ my-app-service │ 80 │ http://192.168.49.2:30007 │ +└───────────┴────────────────┴─────────────┴───────────────────────────┘ +🔗 Starting tunnel for service my-app-service. +┌───────────┬────────────────┬─────────────┬────────────────────────┐ +│ NAMESPACE │ NAME │ TARGET PORT │ URL │ +├───────────┼────────────────┼─────────────┼────────────────────────┤ +│ default │ my-app-service │ │ http://127.0.0.1:57348 │ +└───────────┴────────────────┴─────────────┴────────────────────────┘ +🎉 Opening service default/my-app-service in default browser... +❗ Because you are using a Docker driver on darwin, the terminal needs to be open to run it. +``` +```bash +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get services +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +kubernetes ClusterIP 10.96.0.1 443/TCP 42m +my-app-service NodePort 10.98.179.244 80:30007/TCP 4m16s +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl describe service my-app-service +Name: my-app-service +Namespace: default +Labels: +Annotations: +Selector: app=my-app +Type: NodePort +IP Family Policy: SingleStack +IP Families: IPv4 +IP: 10.98.179.244 +IPs: 10.98.179.244 +Port: 80/TCP +TargetPort: 12345/TCP +NodePort: 30007/TCP +Endpoints: 10.244.0.16:12345,10.244.0.14:12345,10.244.0.15:12345 +Session Affinity: None +External Traffic Policy: Cluster +Internal Traffic Policy: Cluster +Events: +(devops) fountainer@Veronicas-MacBook-Air k8s % kubectl get endpoints +Warning: v1 Endpoints is deprecated in v1.33+; use discovery.k8s.io/v1 EndpointSlice +NAME ENDPOINTS AGE +kubernetes 192.168.49.2:8443 42m +my-app-service 10.244.0.14:12345,10.244.0.15:12345,10.244.0.16:12345 4m36s +(devops) fountainer@Veronicas-MacBook-Air k8s % +``` + +## Operations Performed + +### Commands used to deploy + +- ```bash kubectl apply -f k8s/deployment.yml``` +- ```bash kubectl apply -f k8s/service.yml``` +- ```bash kubectl get pods``` +- ```bash kubectl get services ``` + +### Scaling demonstration output + +![](./../docs/screenshots/lab09-shots/scaling.png) + +### Rolling update demonstration output + +I changed ```bash image: fountainer/my-app:latest``` to ```bash image: fountainer/my-app:2026.03.26```. + +![](./../docs/screenshots/lab09-shots/rollout.png) + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl rollout history deployment/my-app-deployment +deployment.apps/my-app-deployment +REVISION CHANGE-CAUSE +1 +2 +3 + +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl rollout undo deployment/my-app-deployment +deployment.apps/my-app-deployment rolled back +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl rollout status deployment/my-app-deployment +Waiting for deployment "my-app-deployment" rollout to finish: 2 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 2 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 2 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 2 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 3 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 3 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 4 out of 5 new replicas have been updated... +Waiting for deployment "my-app-deployment" rollout to finish: 1 old replicas are pending termination... +Waiting for deployment "my-app-deployment" rollout to finish: 1 old replicas are pending termination... +Waiting for deployment "my-app-deployment" rollout to finish: 1 old replicas are pending termination... +Waiting for deployment "my-app-deployment" rollout to finish: 1 old replicas are pending termination... +Waiting for deployment "my-app-deployment" rollout to finish: 4 of 5 updated replicas are available... +Waiting for deployment "my-app-deployment" rollout to finish: 4 of 5 updated replicas are available... +deployment "my-app-deployment" successfully rolled out +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods +NAME READY STATUS RESTARTS AGE +my-app-deployment-7b5479788b-bj4pt 1/1 Running 0 37s +my-app-deployment-7b5479788b-n2pnb 1/1 Running 0 12s +my-app-deployment-7b5479788b-nvzdr 1/1 Running 0 22s +my-app-deployment-7b5479788b-q9g66 1/1 Running 0 36s +my-app-deployment-7b5479788b-w2nc6 1/1 Running 0 22s +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % +``` + +### Service access method and verification + +I accessed the app using ```bash minikube service my-app-service ``` and verified it by sending requests with curl to endpoints like /health and /ready. + +## Production Considerations + +### What health checks did you implement and why? + +I implemented a liveness probe on /health to restart unhealthy containers and a readiness probe on /ready to ensure pods start receiving traffic only when they are ready to work. + +### Resource limits rationale + +- I set limits to prevent resource overuse, and requests to guarantee the pod gets enough cpu and memory to run reliably. + +### How would you improve this for production? + +- I would add proper logging/monitoring like we did in the previous labs, add autoscaling, consider other update strategies (like canary update). + +### Monitoring and observability strategy + +- In previous labs we used Prometheus for metrics and loki & promtail for logs, also Grafana for dashboard representation + +## Challenges & Solutions + +### Issues encountered + +- I didn't work with NodePort before so I has to stydy it a little bit. Also I didn't know about minikube. + +### How you debugged (logs, describe, events) + +- I researched StackOverflow and other sources, such as documentation for kubernetes and minikube + +### What you learned about Kubernetes + +- I studied kubernetes in the SRE course last semester so I was already pretty familiar with it. We didn't use NodePort service though, and also didn't set up our own cluster since the course team provided us with it. + diff --git a/app_python/k8s/ROLLOUTS.md b/app_python/k8s/ROLLOUTS.md new file mode 100644 index 0000000000..7a37244b4c --- /dev/null +++ b/app_python/k8s/ROLLOUTS.md @@ -0,0 +1,252 @@ +# Documentation + +## Argo Rollouts Setup + +### Installation verification + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl apply -n argo-rollouts -f https://github.com/argoproj/argo-rollouts/releases/latest/download/install.yaml +customresourcedefinition.apiextensions.k8s.io/analysisruns.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/analysistemplates.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/clusteranalysistemplates.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/experiments.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/rollouts.argoproj.io created +serviceaccount/argo-rollouts created +clusterrole.rbac.authorization.k8s.io/argo-rollouts created +clusterrole.rbac.authorization.k8s.io/argo-rollouts-aggregate-to-admin created +clusterrole.rbac.authorization.k8s.io/argo-rollouts-aggregate-to-edit created +clusterrole.rbac.authorization.k8s.io/argo-rollouts-aggregate-to-view created +clusterrolebinding.rbac.authorization.k8s.io/argo-rollouts created +configmap/argo-rollouts-config created +secret/argo-rollouts-notification-secret created +service/argo-rollouts-metrics created +deployment.apps/argo-rollouts created +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n argo-rollouts +NAME READY STATUS RESTARTS AGE +argo-rollouts-5f64f8d68-zxx5z 1/1 Running 0 54s +``` +```bash +==> Fetching downloads for: kubectl-argo-rollouts +✔︎ Formula kubectl-argo-rollouts (v1.8.3) Verified 130.1MB/130.1MB +==> Installing kubectl-argo-rollouts from argoproj/tap +``` + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl argo rollouts version +kubectl-argo-rollouts: v1.8.3+49fa151 + BuildDate: 2025-06-04T22:19:21Z + GitCommit: 49fa1516cf71672b69e265267da4e1d16e1fe114 + GitTreeState: clean + GoVersion: go1.23.9 + Compiler: gc + Platform: darwin/amd64 +``` + +### Dashboard access + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pods -n argo-rollouts +NAME READY STATUS RESTARTS AGE +argo-rollouts-5f64f8d68-zxx5z 1/1 Running 0 12m +argo-rollouts-dashboard-755bbc64c-pnkl6 1/1 Running 0 28s +``` + +![](./../docs/screenshots/lab14-shots/argo-dashboard-access.png) + +### Understand Rollout vs Deployment + +Rollout CRD vs Deployment + +- Rollout and Deployment are kinda similar and both have replicas, selector, template, strategy fields, they manage pod creation. But rollout has additional fields for strategy that allow to perform more controllable rollouts with specific configurations, like rolling an update for a group of users, not for all. + +Additional fields for progressive delivery + +- canary: allows gradual traffic shifting to a new version using steps (e.g., setWeight, pause) +- blueGreen: supports switching between old and new versions using separate services +- steps: defines staged rollout progression +- analysis: integrates automated checks (metrics, tests) during rollout +- pause: enables manual or timed pauses between steps +- trafficRouting: controls how traffic is split between versions (with ingress/service mesh) + + +## Canary Deployment + +### Strategy configuration explained + +The rollout uses a canary strategy to gradually shift traffic from the old version to the new one. It is configured in steps (20%, 40%, 60%, 80%, 100%) with pauses to allow validation and manual control. This approach reduces risk by exposing the new version to a small part of users before full deployment. + +### Step-by-step rollout progression (screenshots from dashboard) + +![](./../docs/screenshots/lab14-shots/canary-prom-1.png) +![](./../docs/screenshots/lab14-shots/canary-prom-2.png) +![](./../docs/screenshots/lab14-shots/canary-prom-3.png) + +### Promotion and abort demonstration + +Promotion (screenshots can be seen in the prev step) + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl argo rollouts get rollout myapp-app-python -n argo-rollouts +Name: myapp-app-python +Namespace: argo-rollouts +Status: ॥ Paused +Message: CanaryPauseStep +Strategy: Canary + Step: 1/9 + SetWeight: 20 + ActualWeight: 25 +Images: fountainer/my-app:16-04 (canary, stable) +Replicas: + Desired: 3 + Current: 4 + Updated: 1 + Ready: 4 + Available: 4 + +NAME KIND STATUS AGE INFO +⟳ myapp-app-python Rollout ॥ Paused 17m +├──# revision:2 +│ └──⧉ myapp-app-python-76b59b6c66 ReplicaSet ✔ Healthy 69s canary +│ └──□ myapp-app-python-76b59b6c66-pgtgq Pod ✔ Running 68s ready:1/1 +└──# revision:1 + └──⧉ myapp-app-python-5bc87cfdf6 ReplicaSet ✔ Healthy 17m stable + ├──□ myapp-app-python-5bc87cfdf6-2tzkc Pod ✔ Running 17m ready:1/1 + ├──□ myapp-app-python-5bc87cfdf6-bnpd6 Pod ✔ Running 17m ready:1/1 + └──□ myapp-app-python-5bc87cfdf6-qfg9s Pod ✔ Running 17m ready:1/1 +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl argo rollouts promote myapp-app-python -n argo-rollouts +rollout 'myapp-app-python' promoted +``` + +Abort + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get rollouts -n argo-rollouts +NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE +myapp-app-python 3 4 1 4 31m +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl argo rollouts abort myapp-app-python -n argo-rollouts +rollout 'myapp-app-python' aborted +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl argo rollouts get rollout myapp-app-python -n argo-rollouts +Name: myapp-app-python +Namespace: argo-rollouts +Status: ✖ Degraded +Message: RolloutAborted: Rollout aborted update to revision 3 +Strategy: Canary + Step: 0/9 + SetWeight: 0 + ActualWeight: 0 +Images: fountainer/my-app:16-04 (stable) +Replicas: + Desired: 3 + Current: 3 + Updated: 0 + Ready: 3 + Available: 3 + +NAME KIND STATUS AGE INFO +⟳ myapp-app-python Rollout ✖ Degraded 32m +├──# revision:3 +│ └──⧉ myapp-app-python-5bc87cfdf6 ReplicaSet • ScaledDown 32m canary +└──# revision:2 + └──⧉ myapp-app-python-76b59b6c66 ReplicaSet ✔ Healthy 16m stable + ├──□ myapp-app-python-76b59b6c66-pgtgq Pod ✔ Running 16m ready:1/1 + ├──□ myapp-app-python-76b59b6c66-7cwr4 Pod ✔ Running 10m ready:1/1 + └──□ myapp-app-python-76b59b6c66-skfdd Pod ✔ Running 10m ready:1/1 +``` +![](./../docs/screenshots/lab14-shots/canary-abort.png) + +## Blue-Green Deployment + +### Strategy configuration explained + +The blue-green strategy uses two environments: active and preview. The preview service runs the new version while the active service continues serving production traffic. After testing, the active service is switched to the new version instantly when promoted. This allows safe testing before release and quick rollback if needed. + +### Preview vs active service + +The active service is used by users in production and always points to the stable version. The preview service is used to test the new version before it is promoted. This separation ensures the new version can be verified without affecting real users. + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl port-forward svc/myapp-app-python-preview 8081:80 -n argo-rollouts +Forwarding from 127.0.0.1:8081 -> 12345 +Forwarding from [::1]:8081 -> 12345 +Handling connection for 8081 +Handling connection for 8081 +``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl port-forward svc/myapp-app-python-service 8080:80 -n argo-rollouts +Forwarding from 127.0.0.1:8080 -> 12345 +Forwarding from [::1]:8080 -> 12345 +Handling connection for 8080 +Handling connection for 8080 +``` + +### Promotion process + +Promotion + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % helm upgrade --install myapp . -n argo-rollouts +Release "myapp" has been upgraded. Happy Helming! +NAME: myapp +LAST DEPLOYED: Thu Apr 30 23:12:57 2026 +NAMESPACE: argo-rollouts +STATUS: deployed +REVISION: 9 +DESCRIPTION: Upgrade complete +TEST SUITE: None +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pods -n argo-rollouts +kubectl get svc -n argo-rollouts +NAME READY STATUS RESTARTS AGE +argo-rollouts-5f64f8d68-zxx5z 1/1 Running 0 6h24m +argo-rollouts-dashboard-755bbc64c-pnkl6 1/1 Running 0 6h12m +myapp-app-python-76b59b6c66-7cwr4 1/1 Running 0 37m +myapp-app-python-76b59b6c66-pgtgq 1/1 Running 0 43m +myapp-app-python-76b59b6c66-skfdd 1/1 Running 0 37m +myapp-app-python-f7cddd7c7-5nvtx 1/1 Running 0 12m +myapp-app-python-f7cddd7c7-xng4z 1/1 Running 0 12m +myapp-app-python-f7cddd7c7-zjfpv 1/1 Running 0 12m +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +argo-rollouts-dashboard ClusterIP 10.106.240.192 3100/TCP 6h12m +argo-rollouts-metrics ClusterIP 10.109.176.51 8090/TCP 6h24m +myapp-app-python-preview ClusterIP 10.97.144.248 80/TCP 16m +myapp-app-python-service NodePort 10.101.217.107 80:30009/TCP 59m +``` + +![](./../docs/screenshots/lab14-shots/blue-green-1.png) +![](./../docs/screenshots/lab14-shots/bg-2.png) +![](./../docs/screenshots/lab14-shots/bg-4.png) + +Rollback + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl argo rollouts undo myapp-app-python -n argo-rollouts +rollout 'myapp-app-python' undo +``` +![](./../docs/screenshots/lab14-shots/bg-5.png) + + +## Strategy Comparison + +### When to use canary vs blue-green + +canary is used when you want to slowly roll out changes to users and reduce risk step by step. blue-green is used when you want an instant switch between versions after testing + +### Pros and cons of each + +- canary is safer for production because it exposes changes gradually, but it takes longer and is more complex to monitor + +- blue-green is faster and simpler at switch time, but requires double resources and has less gradual control. + +### Your recommendation for different scenarios + +use canary for production systems where stability is critical. use blue-green for fast releases or when you want quick testing and instant rollback. + +## CLI Commands Reference + +### Commands you used + +```kubectl argo rollouts get rollout -w``` is used to watch rollout progress. ```kubectl argo rollouts promote``` is used to move to the next step in canary or switch in blue-green. ```kubectl argo rollouts undo``` is used to rollback to the previous version. + +### Monitoring and troubleshooting + +```kubectl get pods```, ```kubectl get svc```, and ```kubectl describe rollout``` are used to check cluster state and debug issues. dashboard is used to visually monitor rollout progress and traffic changes. \ No newline at end of file diff --git a/app_python/k8s/SECRETS.md b/app_python/k8s/SECRETS.md new file mode 100644 index 0000000000..1c62eae2de --- /dev/null +++ b/app_python/k8s/SECRETS.md @@ -0,0 +1,197 @@ +# Documentation + +## Kubernetes Secrets + +### Output of creating and viewing your secret + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl create secret generic app-credentials --from-literal=username=fountainer --from-literal=password=‘mypass293i20@@nekf’ +secret/app-credentials created +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get secret app-credentials -o yaml +apiVersion: v1 +data: + password: 4oCYbXlwYXNzMjkzaTIwQEBuZWtm4oCZ + username: Zm91bnRhaW5lcg== +kind: Secret +metadata: + creationTimestamp: "2026-04-07T14:46:16Z" + name: app-credentials + namespace: default + resourceVersion: "24859" + uid: 6997ca85-68fa-4278-9d51-a6531df977e9 +type: Opaque +``` +### Decoded secret values demonstration + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % echo "4oCYbXlwYXNzMjkzaTIwQEBuZWtm4oCZ" | base64 -d +‘mypass293i20@@nekf’% +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % echo "Zm91bnRhaW5lcg==" | base64 -d +fountainer% +``` +### Explanation of base64 encoding vs encryption + +- Encoding is when we use some publicly accesible algorithm to encode our data. The goal is keeping integrity and usability of the data, it is not really about security. + +- In turn, Encryption is about securuty. It envolves encrypting with an algorithm that can be only resolved by a user who has an encryption key. + +## Helm Secret Integration + +### Chart structure showing secrets.yaml + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % tree app_python/k8s/app_python +app_python/k8s/app_python +├── Chart.yaml +├── charts +├── templates +│ ├── _helpers.tpl +│ ├── deployment.yaml +│ ├── hooks +│ │ ├── post-install-job.yaml +│ │ └── pre-install-job.yaml +│ ├── secrets.yaml +│ └── service.yaml +├── values-dev.yaml +├── values-prod.yaml +└── values.yaml +``` + +### How secrets are consumed in deployment + +- I have $secretName variable that is dynamically set to the name from the values.yaml and values I provide in the helm install command OR defaults to the value from helper. + +### Verification output (env vars in pod, excluding actual values) + +- in pod I have correct env vars: + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl exec -it mysecretrelease-app-python-7975557578-6zc9m -- sh +$ echo $PASSWORD +mypass293i20@@nekf +$ echo $USERNAME +fountainer +``` + +- and outside the secrets are hidden + +from ```bash kubectl describe pod mysecretrelease-app-python-7975557578-6zc9m``` + +```bash +Environment: + PASSWORD: Optional: false + USERNAME: Optional: false +``` + + +## Resource Management + +### Resource limits configuration + +```bash +resources: + requests: + cpu: {{ .Values.resources.requests.cpu }} + memory: {{ .Values.resources.requests.memory }} + limits: + cpu: {{ .Values.resources.limits.cpu }} + memory: {{ .Values.resources.limits.memory }} +``` +- in values.yaml I have + +```bash +resources: + requests: + cpu: "100m" + memory: "128Mi" + limits: + cpu: "500m" + memory: "256Mi" +``` + +### Explanation of requests vs limits + +- requests is a setting that shows kubernates how much resources are needed for a container to run +- limits show how much resources a container is allowed to use (max) + +### How to choose appropriate values + +- you should analyze what processes does your container run and how many cpu/memory it may need +- values can be adjusted by observing the running container +- if you have multiple containers/pods you should constraint them in such a way that they all can work without throttling +- if the memory limit is too low the container can be killed right away + +## Vault Integration + +### Vault installation verification (kubectl get pods) + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl get pod +NAME READY STATUS RESTARTS AGE +mysecretrelease-app-python-7975557578-6zc9m 1/1 Running 0 63m +mysecretrelease-app-python-7975557578-7l4tv 1/1 Running 0 63m +mysecretrelease-app-python-7975557578-bqnpd 1/1 Running 0 63m +mysecretrelease-app-python-7975557578-cjjcb 1/1 Running 0 63m +mysecretrelease-app-python-7975557578-st2jd 1/1 Running 0 63m +vault-0 1/1 Running 0 8m23s +vault-agent-injector-848dd747d7-qvgl2 1/1 Running 0 8m23s +``` + +### Policy and role configuration (sanitized) + +- policy + +```bash +/ $ vault policy write myapp-policy /tmp/myapp-policy.hcl +Success! Uploaded policy: myapp-policy +/ $ vault policy read myapp-policy +path "secret/data/myapp/config" { + capabilities = ["read"] +} +``` + +- role config + +```bash +vault write auth/kubernetes/role/myapp-role \ + bound_service_account_names=default \ + bound_service_account_namespaces=default \ + policies=myapp-policy \ + ttl=48h +``` + + +### Proof of secret injection (show file exists, path structure) + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl exec -it mysecretrelease-app-python-558b98bb9d-8299m -- /bin/sh +Defaulted container "app-python" out of: app-python, vault-agent, vault-agent-init (init) +$ ls -l /vault/secrets +total 4 +-rw-r--r-- 1 100 newuser 180 Apr 7 23:55 config +$ cat /vault/secrets/config +data: map[password:mypass293i20@@nekf username:fountainer] +metadata: map[created_time:2026-04-07T23:32:33.85543147Z custom_metadata: deletion_time: destroyed:false version:1] +$ +``` + +### Explanation of the sidecar injection pattern + +- now every pod contains not only my app container but also vault sidecar container +- vault is able to authenticate in kubernates and inject secrets into the pod + +## Security Analysis + +### Comparison: K8s Secrets vs Vault + +- kubernates secrets are just encoded into base 64 and everyone who gets access to the cluster can decode them and get sensitive data, on the other hand, vault provides data encryption that is much more safer since you need an encryption key to encrypt it + +### When to use each approach + +- encoding is good for keeping data usability and integrity, so different machines can use it (like for seeing special symbols on a web page), it is like... more secure than nothing, but not reeally secure + +- vault encryption is needed for keeping sensitive data secure, like for storing passwords for the services on the virtual machines, etc + +### Production recommendations + +- in production you should always try to use strong encryption algorithms to keep your data secure diff --git a/app_python/k8s/STATEFULSET.md b/app_python/k8s/STATEFULSET.md new file mode 100644 index 0000000000..b5a5b60b72 --- /dev/null +++ b/app_python/k8s/STATEFULSET.md @@ -0,0 +1,168 @@ +# Documentation + +## StatefulSet Overview + +### Why StatefulSet + +It is used when pods need stable identity and storage, like each pod keeping its own data and name even after restart. + +### Differences from Deployment + +Key differences: +- deployment pods are interchangeable and can change names/storage after restarts, while statefulset pods have fixed names (pod-0, pod-1) and their own persistent storage. + +When to use Deployment vs StatefulSet: +- deployment is used for stateless apps (like web servers), and statefulset for apps that need stable data and identity (like databases). + +Examples of stateful workloads: +- databases like mysql/postgresql, message queues, systems like elasticsearch + +### Headless Services + +What is a headless service (clusterIP: None)? +- a service without a cluster ip that lets you directly access individual pods instead of load balancing + +How DNS works with StatefulSets? +- each pod gets its own dns name like pod-0.service-name.namespace.svc.cluster.local, and they can be addressed individually + +## Resource Verification + +### Output of kubectl get pod,sts,svc,pvc + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get statefulset +NAME READY AGE +myapp-app-python 3/3 38s +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pods +NAME READY STATUS RESTARTS AGE +my-app-app-python-5f57899757-4phmz 1/1 Running 1 (7d4h ago) 7d6h +my-app-app-python-5f57899757-6sj7k 1/1 Running 1 (7d4h ago) 7d5h +my-app-app-python-5f57899757-75mlj 1/1 Running 1 (7d4h ago) 7d5h +myapp-app-python-0 1/1 Running 0 42s +myapp-app-python-1 1/1 Running 0 25s +myapp-app-python-2 1/1 Running 0 16s +myapp-app-python-5bc87cfdf6-dhkt6 1/1 Running 0 42s +myapp-app-python-5bc87cfdf6-mxpkd 1/1 Running 0 42s +myapp-app-python-5bc87cfdf6-wpc68 1/1 Running 0 42s +myapp-app-python-7dc6cbf89f-46pbw 1/1 Running 0 42s +myapp-app-python-7dc6cbf89f-9krh8 1/1 Running 0 42s +myapp-app-python-7dc6cbf89f-lp4rh 1/1 Running 0 42s +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pvc +NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS VOLUMEATTRIBUTESCLASS AGE +data-volume-myapp-app-python-0 Bound pvc-2a043668-bbae-4c8d-86dc-ae89242a4b28 100Mi RWO standard 53s +data-volume-myapp-app-python-1 Bound pvc-f9152007-9fff-4292-bc28-d1bc16b0214e 100Mi RWO standard 36s +data-volume-myapp-app-python-2 Bound pvc-cec60c23-bdb5-44df-bf9f-9e2938726dc6 100Mi RWO standard 27s +my-app-app-python-data Bound pvc-a5009930-2af6-4223-8fad-16257b59e9aa 100Mi RWO standard 7d6h +myapp-app-python-data Bound pvc-22a66b4f-e1f6-486f-a528-76f27f090535 100Mi RWO standard 53s +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl get pod,sts,svc,pvc +NAME READY STATUS RESTARTS AGE +pod/my-app-app-python-5f57899757-4phmz 1/1 Running 1 (7d4h ago) 7d6h +pod/my-app-app-python-5f57899757-6sj7k 1/1 Running 1 (7d4h ago) 7d5h +pod/my-app-app-python-5f57899757-75mlj 1/1 Running 1 (7d4h ago) 7d5h +pod/myapp-app-python-0 1/1 Running 0 99s +pod/myapp-app-python-1 1/1 Running 0 82s +pod/myapp-app-python-2 1/1 Running 0 73s +pod/myapp-app-python-5bc87cfdf6-dhkt6 1/1 Running 0 99s +pod/myapp-app-python-5bc87cfdf6-mxpkd 1/1 Running 0 99s +pod/myapp-app-python-5bc87cfdf6-wpc68 1/1 Running 0 99s +pod/myapp-app-python-7dc6cbf89f-46pbw 1/1 Running 0 99s +pod/myapp-app-python-7dc6cbf89f-9krh8 1/1 Running 0 99s +pod/myapp-app-python-7dc6cbf89f-lp4rh 1/1 Running 0 99s + +NAME READY AGE +statefulset.apps/myapp-app-python 3/3 99s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/kubernetes ClusterIP 10.96.0.1 443/TCP 7d8h +service/myapp-app-python-preview ClusterIP 10.98.51.97 80/TCP 99s +service/myapp-app-python-service NodePort 10.110.182.139 80:30009/TCP 99s + +NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS VOLUMEATTRIBUTESCLASS AGE +persistentvolumeclaim/data-volume-myapp-app-python-0 Bound pvc-2a043668-bbae-4c8d-86dc-ae89242a4b28 100Mi RWO standard 99s +persistentvolumeclaim/data-volume-myapp-app-python-1 Bound pvc-f9152007-9fff-4292-bc28-d1bc16b0214e 100Mi RWO standard 82s +persistentvolumeclaim/data-volume-myapp-app-python-2 Bound pvc-cec60c23-bdb5-44df-bf9f-9e2938726dc6 100Mi RWO standard 73s +persistentvolumeclaim/my-app-app-python-data Bound pvc-a5009930-2af6-4223-8fad-16257b59e9aa 100Mi RWO standard 7d6h +persistentvolumeclaim/myapp-app-python-data Bound pvc-22a66b4f-e1f6-486f-a528-76f27f090535 100Mi RWO standard 99s +(devops) fountainer@Veronicas-MacBook-Air app_python % +``` + +## Network Identity + +### DNS resolution outputs + +the naming pattern is ```.``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % kubectl exec -it myapp-app-python-0 -- /bin/sh +$ getent hosts myapp-app-python-0.myapp-app-python-headless +10.244.0.177 myapp-app-python-0.myapp-app-python-headless.default.svc.cluster.local +$ getent hosts myapp-app-python-1.myapp-app-python-headless +10.244.0.179 myapp-app-python-1.myapp-app-python-headless.default.svc.cluster.local +$ getent hosts myapp-app-python-2.myapp-app-python-headless +10.244.0.180 myapp-app-python-2.myapp-app-python-headless.default.svc.cluster.local +``` + +## Per-Pod Storage Evidence + +### Different visit counts per pod + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl port-forward pod/myapp-app-python-0 8080:12345 +Forwarding from 127.0.0.1:8080 -> 12345 +Forwarding from [::1]:8080 -> 12345 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +Handling connection for 8080 +``` + +```bash +fountainer@Veronicas-MacBook-Air DevOps-Core-Course % pyenv shell devops +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl port-forward pod/myapp-app-python-1 8081:12345 +Forwarding from 127.0.0.1:8081 -> 12345 +Forwarding from [::1]:8081 -> 12345 +Handling connection for 8081 +Handling connection for 8081 +Handling connection for 8081 +Handling connection for 8081 +Handling connection for 8081 +``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air DevOps-Core-Course % kubectl port-forward pod/myapp-app-python-2 8082:12345 +Forwarding from 127.0.0.1:8082 -> 12345 +Forwarding from [::1]:8082 -> 12345 +Handling connection for 8082 +Handling connection for 8082 +Handling connection for 8082 +Handling connection for 8082 +``` +```bash +(devops) fountainer@Veronicas-MacBook-Air app_python % curl localhost:8080/visits +{ + "visits": 13 +} +(devops) fountainer@Veronicas-MacBook-Air app_python % curl localhost:8081/visits +{ + "visits": 7 +} +(devops) fountainer@Veronicas-MacBook-Air app_python % curl localhost:8082/visits +{ + "visits": 2 +} +``` + +![](./../docs/screenshots/lab15-shots/visits-diff.png) + +## Persistence Test + +### data survives pod deletion + +![](./../docs/screenshots/lab15-shots/pers_test.png) \ No newline at end of file diff --git a/app_python/k8s/app_python/.helmignore b/app_python/k8s/app_python/.helmignore new file mode 100644 index 0000000000..0e8a0eb36f --- /dev/null +++ b/app_python/k8s/app_python/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/app_python/k8s/app_python/Chart.yaml b/app_python/k8s/app_python/Chart.yaml new file mode 100644 index 0000000000..3e280aeaaf --- /dev/null +++ b/app_python/k8s/app_python/Chart.yaml @@ -0,0 +1,16 @@ +apiVersion: v2 +name: app_python +description: My Python application Helm chart + +type: application +version: 0.1.0 +appVersion: "1.0" + +keywords: + - python + - web +maintainers: + - name: Veronika Levasheva + email: veronikalev2005@gmail.com +sources: + - https://github.com/ffountainer/DevOps-Core-Course diff --git a/app_python/k8s/app_python/files/config.json b/app_python/k8s/app_python/files/config.json new file mode 100644 index 0000000000..ba8808215e --- /dev/null +++ b/app_python/k8s/app_python/files/config.json @@ -0,0 +1,11 @@ +{ + "app_name": "my-app", + "environment": "dev", + "feature_flags": { + "debug": true, + "metrics": true + }, + "settings": { + "log_level": "info" + } +} \ No newline at end of file diff --git a/app_python/k8s/app_python/service-headless.yaml b/app_python/k8s/app_python/service-headless.yaml new file mode 100644 index 0000000000..04d26061e8 --- /dev/null +++ b/app_python/k8s/app_python/service-headless.yaml @@ -0,0 +1,10 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "mychart.fullname" . }}-headless +spec: + clusterIP: None + selector: + {{- include "mychart.selectorLabels" . | nindent 4 }} + ports: + - port: {{ .Values.service.port }} \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/_helpers.tpl b/app_python/k8s/app_python/templates/_helpers.tpl new file mode 100644 index 0000000000..2697f80e58 --- /dev/null +++ b/app_python/k8s/app_python/templates/_helpers.tpl @@ -0,0 +1,50 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "mychart.name" -}} +{{- default .Chart.Name .Values.nameOverride | replace "_" "-" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Create a default fully qualified app name. +*/}} +{{- define "mychart.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | replace "_" "-" | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := include "mychart.name" . }} +{{- printf "%s-%s" .Release.Name $name | replace "_" "-" | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} + +{{/* +Chart name and version. +*/}} +{{- define "mychart.chart" -}} +{{ .Chart.Name }}-{{ .Chart.Version }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "mychart.selectorLabels" -}} +app.kubernetes.io/name: {{ include "mychart.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Common labels. +*/}} +{{- define "mychart.labels" -}} +helm.sh/chart: {{ include "mychart.chart" . }} +{{ include "mychart.selectorLabels" . }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Service name helper. +*/}} +{{- define "mychart.serviceName" -}} +{{ include "mychart.fullname" . }}-service +{{- end }} \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/configmap-env.yaml b/app_python/k8s/app_python/templates/configmap-env.yaml new file mode 100644 index 0000000000..f41c2df7d3 --- /dev/null +++ b/app_python/k8s/app_python/templates/configmap-env.yaml @@ -0,0 +1,10 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "mychart.fullname" . }}-env + labels: + app: {{ include "mychart.name" . }} +data: + APP_NAME: {{ .Values.appName | quote }} + APP_ENV: {{ .Values.environment | quote }} + LOG_LEVEL: {{ .Values.logLevel | quote }} \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/configmap.yaml b/app_python/k8s/app_python/templates/configmap.yaml new file mode 100644 index 0000000000..a037d8bd60 --- /dev/null +++ b/app_python/k8s/app_python/templates/configmap.yaml @@ -0,0 +1,9 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "mychart.fullname" . }}-config + labels: + app: {{ include "mychart.name" . }} +data: + config.json: |- +{{ .Files.Get "files/config.json" | indent 4 }} \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/deployment.yaml b/app_python/k8s/app_python/templates/deployment.yaml new file mode 100644 index 0000000000..c3cada620d --- /dev/null +++ b/app_python/k8s/app_python/templates/deployment.yaml @@ -0,0 +1,82 @@ +{{- $secretName := .Values.secret.name | default (include "mychart.fullname" .) }} + +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "mychart.fullname" . }} + labels: + {{- include "mychart.labels" . | nindent 4 }} +spec: + replicas: {{ .Values.replicaCount }} + strategy: + type: RollingUpdate + rollingUpdate: + maxUnavailable: {{ .Values.strategy.maxUnavailable }} + maxSurge: {{ .Values.strategy.maxSurge }} + selector: + matchLabels: + {{- include "mychart.selectorLabels" . | nindent 6 }} + template: + metadata: + labels: + {{- include "mychart.selectorLabels" . | nindent 8 }} + annotations: + vault.hashicorp.com/agent-inject: "true" + vault.hashicorp.com/role: "myapp-role" + vault.hashicorp.com/agent-inject-secret-config: "secret/data/myapp/config" + spec: + containers: + - name: {{ include "mychart.name" . }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + env: + - name: PASSWORD + valueFrom: + secretKeyRef: + name: {{ $secretName }} + key: password + - name: USERNAME + valueFrom: + secretKeyRef: + name: {{ $secretName }} + key: username + - name: DATA_DIR + value: /app/data + volumeMounts: + - name: config-volume + mountPath: /config + - name: data-volume + mountPath: /app/data + envFrom: + - configMapRef: + name: {{ include "mychart.fullname" . }}-env + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - containerPort: {{ .Values.container.port }} + resources: + requests: + cpu: {{ .Values.resources.requests.cpu }} + memory: {{ .Values.resources.requests.memory }} + limits: + cpu: {{ .Values.resources.limits.cpu }} + memory: {{ .Values.resources.limits.memory }} + livenessProbe: + httpGet: + path: {{ .Values.livenessProbe.path }} + port: {{ .Values.container.port }} + initialDelaySeconds: {{ .Values.livenessProbe.initialDelaySeconds }} + periodSeconds: {{ .Values.livenessProbe.periodSeconds }} + timeoutSeconds: {{ .Values.livenessProbe.timeoutSeconds }} + failureThreshold: {{ .Values.livenessProbe.failureThreshold }} + readinessProbe: + httpGet: + path: {{ .Values.readinessProbe.path }} + port: {{ .Values.container.port }} + initialDelaySeconds: {{ .Values.readinessProbe.initialDelaySeconds }} + periodSeconds: {{ .Values.readinessProbe.periodSeconds }} + volumes: + - name: config-volume + configMap: + name: {{ include "mychart.fullname" . }}-config + - name: data-volume + persistentVolumeClaim: + claimName: {{ include "mychart.fullname" . }}-data \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/headless-service.yaml b/app_python/k8s/app_python/templates/headless-service.yaml new file mode 100644 index 0000000000..04d26061e8 --- /dev/null +++ b/app_python/k8s/app_python/templates/headless-service.yaml @@ -0,0 +1,10 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "mychart.fullname" . }}-headless +spec: + clusterIP: None + selector: + {{- include "mychart.selectorLabels" . | nindent 4 }} + ports: + - port: {{ .Values.service.port }} \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/hooks/post-install-job.yaml b/app_python/k8s/app_python/templates/hooks/post-install-job.yaml new file mode 100644 index 0000000000..578cdf58a7 --- /dev/null +++ b/app_python/k8s/app_python/templates/hooks/post-install-job.yaml @@ -0,0 +1,26 @@ +apiVersion: batch/v1 +kind: Job +metadata: + name: "{{ include "mychart.fullname" . }}-post-install" + labels: + {{- include "mychart.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": post-install + "helm.sh/hook-weight": "5" + "helm.sh/hook-delete-policy": hook-succeeded +spec: + template: + metadata: + name: "{{ include "mychart.fullname" . }}-post-install" + spec: + restartPolicy: Never + containers: + - name: post-install-job + image: busybox + command: + - sh + - -c + - | + echo "Post-install validation running" + sleep 10 + echo "Validation passed" \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/hooks/pre-install-job.yaml b/app_python/k8s/app_python/templates/hooks/pre-install-job.yaml new file mode 100644 index 0000000000..90018bbb06 --- /dev/null +++ b/app_python/k8s/app_python/templates/hooks/pre-install-job.yaml @@ -0,0 +1,26 @@ +apiVersion: batch/v1 +kind: Job +metadata: + name: "{{ include "mychart.fullname" . }}-pre-install" + labels: + {{- include "mychart.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": pre-install + "helm.sh/hook-weight": "-5" + "helm.sh/hook-delete-policy": hook-succeeded +spec: + template: + metadata: + name: "{{ include "mychart.fullname" . }}-pre-install" + spec: + restartPolicy: Never + containers: + - name: pre-install-job + image: busybox + command: + - sh + - -c + - | + echo "Pre-install task running" + sleep 10 + echo "Pre-install completed" \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/init.yaml b/app_python/k8s/app_python/templates/init.yaml new file mode 100644 index 0000000000..e7b959f9de --- /dev/null +++ b/app_python/k8s/app_python/templates/init.yaml @@ -0,0 +1,31 @@ +apiVersion: v1 +kind: Pod +metadata: + name: init-download-pod + namespace: default +spec: + initContainers: + - name: init-download + image: busybox:1.36 + command: + - sh + - -c + - wget -O /work-dir/index.html https://example.com + volumeMounts: + - name: workdir + mountPath: /work-dir + + containers: + - name: main-app + image: busybox:1.36 + command: + - sh + - -c + - sleep 3600 + volumeMounts: + - name: workdir + mountPath: /data + + volumes: + - name: workdir + emptyDir: {} \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/nginx.yaml b/app_python/k8s/app_python/templates/nginx.yaml new file mode 100644 index 0000000000..cc07ba1e93 --- /dev/null +++ b/app_python/k8s/app_python/templates/nginx.yaml @@ -0,0 +1,32 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: myservice + namespace: default +spec: + replicas: 1 + selector: + matchLabels: + app: myservice + template: + metadata: + labels: + app: myservice + spec: + containers: + - name: nginx + image: nginx + ports: + - containerPort: 80 +--- +apiVersion: v1 +kind: Service +metadata: + name: myservice + namespace: default +spec: + selector: + app: myservice + ports: + - port: 80 + targetPort: 80 \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/preview-service.yaml b/app_python/k8s/app_python/templates/preview-service.yaml new file mode 100644 index 0000000000..e59503c982 --- /dev/null +++ b/app_python/k8s/app_python/templates/preview-service.yaml @@ -0,0 +1,10 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "mychart.fullname" . }}-preview +spec: + selector: + {{- include "mychart.selectorLabels" . | nindent 4 }} + ports: + - port: {{ .Values.service.port }} + targetPort: {{ .Values.service.targetPort }} \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/pvc.yaml b/app_python/k8s/app_python/templates/pvc.yaml new file mode 100644 index 0000000000..a930a3cb18 --- /dev/null +++ b/app_python/k8s/app_python/templates/pvc.yaml @@ -0,0 +1,17 @@ +{{- if .Values.persistence.enabled }} +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: {{ include "mychart.fullname" . }}-data + labels: + {{- include "mychart.labels" . | nindent 4 }} +spec: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: {{ .Values.persistence.size }} + {{- if .Values.persistence.storageClass }} + storageClassName: {{ .Values.persistence.storageClass }} + {{- end }} +{{- end }} \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/rollout.yaml b/app_python/k8s/app_python/templates/rollout.yaml new file mode 100644 index 0000000000..6d4e687d75 --- /dev/null +++ b/app_python/k8s/app_python/templates/rollout.yaml @@ -0,0 +1,86 @@ +{{- $secretName := .Values.secret.name | default (include "mychart.fullname" .) }} + +apiVersion: argoproj.io/v1alpha1 +kind: Rollout +metadata: + name: {{ include "mychart.fullname" . }} + labels: + {{- include "mychart.labels" . | nindent 4 }} +spec: + replicas: {{ .Values.replicaCount }} + + selector: + matchLabels: + {{- include "mychart.selectorLabels" . | nindent 6 }} + + template: + metadata: + labels: + {{- include "mychart.selectorLabels" . | nindent 8 }} + annotations: + vault.hashicorp.com/agent-inject: "true" + vault.hashicorp.com/role: "myapp-role" + vault.hashicorp.com/agent-inject-secret-config: "secret/data/myapp/config" + spec: + containers: + - name: {{ include "mychart.name" . }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + env: + - name: PASSWORD + valueFrom: + secretKeyRef: + name: {{ $secretName }} + key: password + - name: USERNAME + valueFrom: + secretKeyRef: + name: {{ $secretName }} + key: username + - name: DATA_DIR + value: /app/data + volumeMounts: + - name: config-volume + mountPath: /config + - name: data-volume + mountPath: /app/data + envFrom: + - configMapRef: + name: {{ include "mychart.fullname" . }}-env + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - containerPort: {{ .Values.container.port }} + resources: + requests: + cpu: {{ .Values.resources.requests.cpu }} + memory: {{ .Values.resources.requests.memory }} + limits: + cpu: {{ .Values.resources.limits.cpu }} + memory: {{ .Values.resources.limits.memory }} + livenessProbe: + httpGet: + path: {{ .Values.livenessProbe.path }} + port: {{ .Values.container.port }} + initialDelaySeconds: {{ .Values.livenessProbe.initialDelaySeconds }} + periodSeconds: {{ .Values.livenessProbe.periodSeconds }} + timeoutSeconds: {{ .Values.livenessProbe.timeoutSeconds }} + failureThreshold: {{ .Values.livenessProbe.failureThreshold }} + readinessProbe: + httpGet: + path: {{ .Values.readinessProbe.path }} + port: {{ .Values.container.port }} + initialDelaySeconds: {{ .Values.readinessProbe.initialDelaySeconds }} + periodSeconds: {{ .Values.readinessProbe.periodSeconds }} + + volumes: + - name: config-volume + configMap: + name: {{ include "mychart.fullname" . }}-config + - name: data-volume + persistentVolumeClaim: + claimName: {{ include "mychart.fullname" . }}-data + + strategy: + blueGreen: + activeService: {{ include "mychart.fullname" . }}-service + previewService: {{ include "mychart.fullname" . }}-preview + autoPromotionEnabled: false \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/secrets.yaml b/app_python/k8s/app_python/templates/secrets.yaml new file mode 100644 index 0000000000..2460f91d72 --- /dev/null +++ b/app_python/k8s/app_python/templates/secrets.yaml @@ -0,0 +1,12 @@ +{{- $secretName := .Values.secret.name | default (include "mychart.fullname" .) }} + +apiVersion: v1 +kind: Secret +metadata: + name: {{ $secretName }} + labels: + {{- include "mychart.labels" . | nindent 4 }} +type: Opaque +stringData: + username: {{ .Values.secret.data.username | quote }} + password: {{ .Values.secret.data.password | quote }} \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/service.yaml b/app_python/k8s/app_python/templates/service.yaml new file mode 100644 index 0000000000..558f0675e3 --- /dev/null +++ b/app_python/k8s/app_python/templates/service.yaml @@ -0,0 +1,13 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "mychart.fullname" . }}-service +spec: + type: {{ .Values.service.type }} + selector: + {{- include "mychart.selectorLabels" . | nindent 6 }} + ports: + - protocol: {{ .Values.service.protocol }} + port: {{ .Values.service.port }} + targetPort: {{ .Values.service.targetPort }} + nodePort: {{ .Values.service.nodePort }} \ No newline at end of file diff --git a/app_python/k8s/app_python/templates/statefulset.yaml b/app_python/k8s/app_python/templates/statefulset.yaml new file mode 100644 index 0000000000..333b200ca0 --- /dev/null +++ b/app_python/k8s/app_python/templates/statefulset.yaml @@ -0,0 +1,84 @@ +{{- $secretName := .Values.secret.name | default (include "mychart.fullname" .) }} + +apiVersion: apps/v1 +kind: StatefulSet +metadata: + name: {{ include "mychart.fullname" . }} + labels: + {{- include "mychart.labels" . | nindent 4 }} +spec: + serviceName: {{ include "mychart.fullname" . }}-headless + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + {{- include "mychart.selectorLabels" . | nindent 6 }} + + template: + metadata: + labels: + {{- include "mychart.selectorLabels" . | nindent 8 }} + annotations: + vault.hashicorp.com/agent-inject: "true" + vault.hashicorp.com/role: "myapp-role" + vault.hashicorp.com/agent-inject-secret-config: "secret/data/myapp/config" + spec: + containers: + - name: {{ include "mychart.name" . }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + env: + - name: PASSWORD + valueFrom: + secretKeyRef: + name: {{ $secretName }} + key: password + - name: USERNAME + valueFrom: + secretKeyRef: + name: {{ $secretName }} + key: username + - name: DATA_DIR + value: /app/data + volumeMounts: + - name: config-volume + mountPath: /config + - name: data-volume + mountPath: /app/data + envFrom: + - configMapRef: + name: {{ include "mychart.fullname" . }}-env + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - containerPort: {{ .Values.container.port }} + resources: + requests: + cpu: {{ .Values.resources.requests.cpu }} + memory: {{ .Values.resources.requests.memory }} + limits: + cpu: {{ .Values.resources.limits.cpu }} + memory: {{ .Values.resources.limits.memory }} + livenessProbe: + httpGet: + path: {{ .Values.livenessProbe.path }} + port: {{ .Values.container.port }} + initialDelaySeconds: {{ .Values.livenessProbe.initialDelaySeconds }} + periodSeconds: {{ .Values.livenessProbe.periodSeconds }} + timeoutSeconds: {{ .Values.livenessProbe.timeoutSeconds }} + failureThreshold: {{ .Values.livenessProbe.failureThreshold }} + readinessProbe: + httpGet: + path: {{ .Values.readinessProbe.path }} + port: {{ .Values.container.port }} + initialDelaySeconds: {{ .Values.readinessProbe.initialDelaySeconds }} + periodSeconds: {{ .Values.readinessProbe.periodSeconds }} + volumes: + - name: config-volume + configMap: + name: {{ include "mychart.fullname" . }}-config + volumeClaimTemplates: + - metadata: + name: data-volume + spec: + accessModes: [ "ReadWriteOnce" ] + resources: + requests: + storage: {{ .Values.persistence.size }} diff --git a/app_python/k8s/app_python/templates/waiting.yaml b/app_python/k8s/app_python/templates/waiting.yaml new file mode 100644 index 0000000000..12a9e5575b --- /dev/null +++ b/app_python/k8s/app_python/templates/waiting.yaml @@ -0,0 +1,20 @@ +apiVersion: v1 +kind: Pod +metadata: + name: wait-service-pod + namespace: default +spec: + initContainers: + - name: wait-for-service + image: busybox:1.36 + command: + - sh + - -c + - until wget -qO- http://myservice.default.svc.cluster.local; do echo waiting for service; sleep 2; done + containers: + - name: main-app + image: busybox:1.36 + command: + - sh + - -c + - echo Service found! && sleep 3600 \ No newline at end of file diff --git a/app_python/k8s/app_python/values-dev.yaml b/app_python/k8s/app_python/values-dev.yaml new file mode 100644 index 0000000000..81c63488ec --- /dev/null +++ b/app_python/k8s/app_python/values-dev.yaml @@ -0,0 +1,40 @@ +replicaCount: 1 + +image: + repository: fountainer/my-app + tag: "16-04" + pullPolicy: Always + +container: + port: 12345 + +resources: + requests: + cpu: "50m" + memory: "64Mi" + limits: + cpu: "100m" + memory: "128Mi" + +strategy: + maxUnavailable: 1 + maxSurge: 1 + +livenessProbe: + path: /health + initialDelaySeconds: 5 + periodSeconds: 10 + timeoutSeconds: 5 + failureThreshold: 3 + +readinessProbe: + path: /ready + initialDelaySeconds: 2 + periodSeconds: 5 + +service: + type: NodePort + port: 80 + targetPort: 12345 + protocol: TCP + nodePort: 30007 \ No newline at end of file diff --git a/app_python/k8s/app_python/values-prod.yaml b/app_python/k8s/app_python/values-prod.yaml new file mode 100644 index 0000000000..0c3548c5d2 --- /dev/null +++ b/app_python/k8s/app_python/values-prod.yaml @@ -0,0 +1,40 @@ +replicaCount: 3 + +image: + repository: fountainer/my-app + tag: "16-04" + pullPolicy: Always + +container: + port: 12345 + +resources: + requests: + cpu: "200m" + memory: "256Mi" + limits: + cpu: "500m" + memory: "512Mi" + +strategy: + maxUnavailable: 1 + maxSurge: 1 + +livenessProbe: + path: /health + initialDelaySeconds: 30 + periodSeconds: 5 + timeoutSeconds: 5 + failureThreshold: 5 + +readinessProbe: + path: /ready + initialDelaySeconds: 10 + periodSeconds: 3 + +service: + type: LoadBalancer + port: 80 + targetPort: 12345 + protocol: TCP + nodePort: 30008 \ No newline at end of file diff --git a/app_python/k8s/app_python/values.yaml b/app_python/k8s/app_python/values.yaml new file mode 100644 index 0000000000..b0ce838464 --- /dev/null +++ b/app_python/k8s/app_python/values.yaml @@ -0,0 +1,60 @@ +replicaCount: 3 + +image: + repository: fountainer/my-app + tag: "2026.05.01" + pullPolicy: Always + +container: + port: 12345 + +persistence: + size: 1Gi + +storageClass: "" + +resources: + requests: + cpu: "100m" + memory: "128Mi" + limits: + cpu: "500m" + memory: "256Mi" + +strategy: + maxUnavailable: 1 + maxSurge: 1 + +livenessProbe: + path: /health + initialDelaySeconds: 10 + periodSeconds: 10 + timeoutSeconds: 5 + failureThreshold: 5 + +readinessProbe: + path: /ready + initialDelaySeconds: 5 + periodSeconds: 5 + +service: + type: NodePort + port: 80 + targetPort: 12345 + protocol: TCP + nodePort: 30009 + +secret: + name: app-credentials + data: + username: "placeholder-user" + password: "placeholder-password" + +appName: my-app +environment: dev +logLevel: info + +persistence: + enabled: true + size: 100Mi + storageClass: "" \ No newline at end of file diff --git a/app_python/k8s/app_python/vault/myapp-policy.hcl b/app_python/k8s/app_python/vault/myapp-policy.hcl new file mode 100644 index 0000000000..230c2125cb --- /dev/null +++ b/app_python/k8s/app_python/vault/myapp-policy.hcl @@ -0,0 +1,3 @@ +path "secret/data/myapp/config" { + capabilities = ["read"] +} \ No newline at end of file diff --git a/app_python/k8s/argocd/application-dev.yaml b/app_python/k8s/argocd/application-dev.yaml new file mode 100644 index 0000000000..587c67c97d --- /dev/null +++ b/app_python/k8s/argocd/application-dev.yaml @@ -0,0 +1,26 @@ +apiVersion: argoproj.io/v1alpha1 +kind: Application +metadata: + name: python-app-dev + namespace: argocd +spec: + project: default + + source: + repoURL: https://github.com/ffountainer/DevOps-Core-Course + targetRevision: lab13 + path: app_python/k8s/app_python + helm: + valueFiles: + - values-dev.yaml + + destination: + server: https://kubernetes.default.svc + namespace: dev + + syncPolicy: + automated: + prune: true + selfHeal: true + syncOptions: + - CreateNamespace=true \ No newline at end of file diff --git a/app_python/k8s/argocd/application-prod.yaml b/app_python/k8s/argocd/application-prod.yaml new file mode 100644 index 0000000000..9ada9f09eb --- /dev/null +++ b/app_python/k8s/argocd/application-prod.yaml @@ -0,0 +1,23 @@ +apiVersion: argoproj.io/v1alpha1 +kind: Application +metadata: + name: python-app-prod + namespace: argocd +spec: + project: default + + source: + repoURL: https://github.com/ffountainer/DevOps-Core-Course + targetRevision: lab13 + path: app_python/k8s/app_python + helm: + valueFiles: + - values-prod.yaml + + destination: + server: https://kubernetes.default.svc + namespace: prod + + syncPolicy: + syncOptions: + - CreateNamespace=true \ No newline at end of file diff --git a/app_python/k8s/argocd/application.yaml b/app_python/k8s/argocd/application.yaml new file mode 100644 index 0000000000..72e9fd692c --- /dev/null +++ b/app_python/k8s/argocd/application.yaml @@ -0,0 +1,21 @@ +apiVersion: argoproj.io/v1alpha1 +kind: Application +metadata: + name: my-app + namespace: argocd +spec: + project: default + + source: + repoURL: https://github.com/ffountainer/DevOps-Core-Course + targetRevision: lab13 + path: app_python/k8s/app_python + helm: + valueFiles: + - values.yaml + + destination: + server: https://kubernetes.default.svc + namespace: default + + syncPolicy: {} \ No newline at end of file diff --git a/app_python/k8s/deployment.yml b/app_python/k8s/deployment.yml new file mode 100644 index 0000000000..8be175e432 --- /dev/null +++ b/app_python/k8s/deployment.yml @@ -0,0 +1,47 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: my-app-deployment + labels: + app: my-app +spec: + replicas: 5 + strategy: + type: RollingUpdate + rollingUpdate: + maxUnavailable: 1 + maxSurge: 1 + selector: + matchLabels: + app: my-app + template: + metadata: + labels: + app: my-app + spec: + containers: + - name: app-python + image: fountainer/my-app:2026.03.26 + ports: + - containerPort: 12345 + resources: + requests: + cpu: "100m" + memory: "128Mi" + limits: + cpu: "500m" + memory: "256Mi" + livenessProbe: + httpGet: + path: /health + port: 12345 + initialDelaySeconds: 10 + periodSeconds: 10 + timeoutSeconds: 5 + failureThreshold: 5 + readinessProbe: + httpGet: + path: /ready + port: 12345 + initialDelaySeconds: 5 + periodSeconds: 5 \ No newline at end of file diff --git a/app_python/monitoring/docker-compose.yml b/app_python/monitoring/docker-compose.yml new file mode 100644 index 0000000000..84f8d57b49 --- /dev/null +++ b/app_python/monitoring/docker-compose.yml @@ -0,0 +1,138 @@ +services: + loki: + image: grafana/loki:3.0.0 + container_name: loki + ports: + - "3100:3100" + command: -config.file=/etc/loki/config.yml + healthcheck: + test: ["CMD-SHELL", "wget --no-verbose --tries=1 --spider http://localhost:3100/ready || exit 1"] + interval: 10s + timeout: 5s + retries: 5 + start_period: 10s + volumes: + - ./loki/config.yml:/etc/loki/config.yml + - loki-data:/loki + networks: + - logging + deploy: + resources: + limits: + cpus: "1.0" + memory: 1G + reservations: + cpus: "0.50" + memory: 512M + promtail: + image: grafana/promtail:3.0.0 + container_name: promtail + ports: + - "9080:9080" + command: -config.file=/etc/promtail/config.yml + volumes: + - ./promtail/config.yml:/etc/promtail/config.yml + - /var/lib/docker/containers:/var/lib/docker/containers:ro + - /var/run/docker.sock:/var/run/docker.sock:ro + depends_on: + - loki + networks: + - logging + deploy: + resources: + limits: + cpus: "0.25" + memory: 256M + reservations: + cpus: "0.10" + memory: 128M + grafana: + image: grafana/grafana:12.3.1 + container_name: grafana + ports: + - "3000:3000" + healthcheck: + test: ["CMD-SHELL", "wget --no-verbose --tries=1 --spider http://localhost:3000/api/health || exit 1"] + interval: 10s + timeout: 5s + retries: 5 + start_period: 10s + environment: + - GF_AUTH_ANONYMOUS_ENABLED=false + - GF_SECURITY_ADMIN_PASSWORD=${GF_PASSWORD} + - GF_SECURITY_ADMIN_EMAIL=${GF_EMAIL} + volumes: + - grafana-data:/var/lib/grafana + depends_on: + - loki + networks: + - logging + deploy: + resources: + limits: + cpus: "0.5" + memory: 512M + reservations: + cpus: "0.25" + memory: 256M + app-python: + image: fountainer/my-app:latest + container_name: app-python + ports: + - "1999:12345" + healthcheck: + test: ["CMD-SHELL", "curl -f http://localhost:12345/health || exit 1"] + interval: 10s + timeout: 5s + retries: 5 + networks: + - logging + labels: + logging: "promtail" + app: "my-app" + deploy: + resources: + limits: + cpus: "0.5" + memory: 256M + reservations: + cpus: "0.10" + memory: 128M + prometheus: + image: prom/prometheus:v3.9.0 + container_name: prometheus + ports: + - "9090:9090" + healthcheck: + test: ["CMD-SHELL", "wget --no-verbose --tries=1 --spider http://localhost:9090/-/healthy || exit 1"] + interval: 10s + timeout: 5s + retries: 5 + command: + - --config.file=/etc/prometheus/prometheus.yml + - --storage.tsdb.retention.time=15d + - --storage.tsdb.retention.size=10GB + volumes: + - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml + - prometheus-data:/prometheus + networks: + - logging + depends_on: + - app-python + - loki + - grafana + deploy: + resources: + limits: + cpus: "1.0" + memory: 1G +volumes: + loki-data: + grafana-data: + prometheus-data: +networks: + logging: + driver: bridge + + + diff --git a/app_python/monitoring/docs/LAB07.md b/app_python/monitoring/docs/LAB07.md new file mode 100644 index 0000000000..02946794ee --- /dev/null +++ b/app_python/monitoring/docs/LAB07.md @@ -0,0 +1 @@ +!!!!!! real LAB07.md documentation lies in the app_python/docs/LAB07.md, since all prev labs documentation files were there, and I wanted to remain consistent. Please check this file, it has everything required by the task \ No newline at end of file diff --git a/app_python/monitoring/docs/LAB08.md b/app_python/monitoring/docs/LAB08.md new file mode 100644 index 0000000000..8da919fdae --- /dev/null +++ b/app_python/monitoring/docs/LAB08.md @@ -0,0 +1 @@ +!!!!!! real LAB08.md documentation lies in the app_python/docs/LAB08.md, since all prev labs documentation files were there, and I wanted to remain consistent. Please check this file, it has everything required by the task \ No newline at end of file diff --git a/app_python/monitoring/loki/config.yml b/app_python/monitoring/loki/config.yml new file mode 100644 index 0000000000..9a27a4c15d --- /dev/null +++ b/app_python/monitoring/loki/config.yml @@ -0,0 +1,31 @@ +auth_enabled: false +server: + http_listen_port: 3100 +common: + path_prefix: /loki + storage: + filesystem: + chunks_directory: /loki/chunks + rules_directory: /loki/rules + replication_factor: 1 + ring: + kvstore: + store: inmemory +schema_config: + configs: + - from: 2026-03-01 + store: tsdb + object_store: filesystem + schema: v13 + index: + prefix: index_ + period: 24h +storage_config: + filesystem: + directory: /loki/chunks +limits_config: + retention_period: 168h +compactor: + working_directory: /loki/compactor + retention_enabled: true + delete_request_store: filesystem \ No newline at end of file diff --git a/app_python/monitoring/prometheus/dashboard.json b/app_python/monitoring/prometheus/dashboard.json new file mode 100644 index 0000000000..d63d022ade --- /dev/null +++ b/app_python/monitoring/prometheus/dashboard.json @@ -0,0 +1,630 @@ +{ + "annotations": { + "list": [ + { + "builtIn": 1, + "datasource": { + "type": "grafana", + "uid": "-- Grafana --" + }, + "enable": true, + "hide": true, + "iconColor": "rgba(0, 211, 255, 1)", + "name": "Annotations & Alerts", + "type": "dashboard" + } + ] + }, + "editable": true, + "fiscalYearStartMonth": 0, + "graphTooltip": 0, + "links": [], + "panels": [ + { + "datasource": { + "type": "prometheus", + "uid": "ffgik5dl3u2o0c" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisBorderShow": false, + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "barWidthFactor": 0.6, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "insertNulls": false, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "type": "linear" + }, + "showPoints": "auto", + "showValues": false, + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": 0 + }, + { + "color": "red", + "value": 80 + } + ] + } + }, + "overrides": [] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 0 + }, + "id": 1, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "hideZeros": false, + "mode": "single", + "sort": "none" + } + }, + "pluginVersion": "12.3.1", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "ffgik5dl3u2o0c" + }, + "editorMode": "code", + "expr": "sum(rate(http_requests_total[5m])) by (endpoint)", + "legendFormat": "", + "range": true, + "refId": "A" + } + ], + "title": "request rate", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "ffgik5dl3u2o0c" + }, + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "red", + "mode": "fixed" + }, + "custom": { + "axisBorderShow": false, + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "barWidthFactor": 0.6, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "insertNulls": false, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "type": "linear" + }, + "showPoints": "auto", + "showValues": false, + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": 0 + }, + { + "color": "red", + "value": 0 + } + ] + } + }, + "overrides": [ + { + "__systemRef": "hideSeriesFrom", + "matcher": { + "id": "byNames", + "options": { + "mode": "exclude", + "names": [ + "sum(rate(http_requests_total{status_code=~\"[45]..\"}[5m]))" + ], + "prefix": "All except:", + "readOnly": true + } + }, + "properties": [ + { + "id": "custom.hideFrom", + "value": { + "legend": false, + "tooltip": true, + "viz": true + } + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 0 + }, + "id": 2, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "hideZeros": false, + "mode": "single", + "sort": "none" + } + }, + "pluginVersion": "12.3.1", + "targets": [ + { + "editorMode": "code", + "expr": "sum(rate(http_requests_total{status_code=~\"[45]..\"}[5m]))", + "legendFormat": "__auto", + "range": true, + "refId": "A" + } + ], + "title": "error rate", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "ffgik5dl3u2o0c" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + } + }, + "mappings": [] + }, + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "404" + }, + "properties": [ + { + "id": "color", + "value": { + "fixedColor": "light-red", + "mode": "fixed" + } + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 8 + }, + "id": 5, + "options": { + "legend": { + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "pieType": "pie", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "sort": "desc", + "tooltip": { + "hideZeros": false, + "mode": "single", + "sort": "none" + } + }, + "pluginVersion": "12.3.1", + "targets": [ + { + "editorMode": "code", + "expr": "sum by (status_code) (rate(http_requests_total[5m]))", + "legendFormat": "__auto", + "range": true, + "refId": "A" + } + ], + "title": "status code distribution", + "type": "piechart" + }, + { + "datasource": { + "type": "prometheus", + "uid": "ffgik5dl3u2o0c" + }, + "fieldConfig": { + "defaults": { + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "scaleDistribution": { + "type": "linear" + } + }, + "unit": "arcsec" + }, + "overrides": [] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 8 + }, + "id": 3, + "options": { + "calculate": false, + "cellGap": 1, + "color": { + "exponent": 0.5, + "fill": "dark-orange", + "mode": "scheme", + "reverse": false, + "scale": "exponential", + "scheme": "Oranges", + "steps": 64 + }, + "exemplars": { + "color": "rgba(255,0,255,0.7)" + }, + "filterValues": { + "le": 1e-9 + }, + "legend": { + "show": true + }, + "rowsFrame": { + "layout": "auto" + }, + "tooltip": { + "mode": "single", + "showColorScale": false, + "yHistogram": false + }, + "yAxis": { + "axisPlacement": "left", + "reverse": false + } + }, + "pluginVersion": "12.3.1", + "targets": [ + { + "editorMode": "code", + "expr": "rate(http_request_duration_seconds_bucket[5m])", + "legendFormat": "__auto", + "range": true, + "refId": "A" + } + ], + "title": "latency heatmap", + "type": "heatmap" + }, + { + "datasource": { + "type": "prometheus", + "uid": "ffgik5dl3u2o0c" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisBorderShow": false, + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "barWidthFactor": 0.6, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "insertNulls": false, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "type": "linear" + }, + "showPoints": "auto", + "showValues": false, + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": 0 + }, + { + "color": "red", + "value": 80 + } + ] + } + }, + "overrides": [] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 16 + }, + "id": 7, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "hideZeros": false, + "mode": "single", + "sort": "none" + } + }, + "pluginVersion": "12.3.1", + "targets": [ + { + "editorMode": "code", + "expr": "histogram_quantile(0.95, rate(http_request_duration_seconds_bucket[5m]))", + "legendFormat": "__auto", + "range": true, + "refId": "A" + } + ], + "title": "p95 Latency", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "ffgik5dl3u2o0c" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": 0 + } + ] + } + }, + "overrides": [] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 16 + }, + "id": 4, + "options": { + "minVizHeight": 75, + "minVizWidth": 75, + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "showThresholdLabels": false, + "showThresholdMarkers": true, + "sizing": "auto" + }, + "pluginVersion": "12.3.1", + "targets": [ + { + "editorMode": "code", + "expr": "http_requests_in_progress", + "legendFormat": "__auto", + "range": true, + "refId": "A" + } + ], + "title": "active requests", + "type": "gauge" + }, + { + "datasource": { + "type": "prometheus", + "uid": "ffgik5dl3u2o0c" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": 0 + }, + { + "color": "red", + "value": 0 + }, + { + "color": "semi-dark-green", + "value": 1 + } + ] + } + }, + "overrides": [] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 24 + }, + "id": 6, + "options": { + "colorMode": "value", + "graphMode": "area", + "justifyMode": "auto", + "orientation": "auto", + "percentChangeColorMode": "standard", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "showPercentChange": false, + "textMode": "auto", + "wideLayout": true + }, + "pluginVersion": "12.3.1", + "targets": [ + { + "editorMode": "code", + "expr": "up{job=\"app\"}", + "legendFormat": "__auto", + "range": true, + "refId": "A" + } + ], + "title": "service health", + "type": "stat" + } + ], + "preload": false, + "schemaVersion": 42, + "tags": [], + "templating": { + "list": [] + }, + "time": { + "from": "now-5m", + "to": "now" + }, + "timepicker": {}, + "timezone": "browser", + "title": "devops lab8", + "uid": "adt5g7d", + "version": 11 +} \ No newline at end of file diff --git a/app_python/monitoring/prometheus/prometheus.yml b/app_python/monitoring/prometheus/prometheus.yml new file mode 100644 index 0000000000..442e8ae576 --- /dev/null +++ b/app_python/monitoring/prometheus/prometheus.yml @@ -0,0 +1,23 @@ +global: + scrape_interval: 15s + evaluation_interval: 15s + +scrape_configs: + - job_name: 'prometheus' + static_configs: + - targets: ['localhost:9090'] + + - job_name: 'app' + static_configs: + - targets: ['app-python:12345'] + metrics_path: /metrics + + - job_name: 'loki' + static_configs: + - targets: ['loki:3100'] + metrics_path: /metrics + + - job_name: 'grafana' + static_configs: + - targets: ['grafana:3000'] + metrics_path: /metrics \ No newline at end of file diff --git a/app_python/monitoring/promtail/config.yml b/app_python/monitoring/promtail/config.yml new file mode 100644 index 0000000000..02c6e0501c --- /dev/null +++ b/app_python/monitoring/promtail/config.yml @@ -0,0 +1,22 @@ +server: + http_listen_port: 9080 +positions: + filename: "/tmp/positions.yaml" + sync_period: 10s + ignore_invalid_yaml: false +clients: + - url: http://loki:3100/loki/api/v1/push +scrape_configs: + - job_name: docker + docker_sd_configs: + - host: unix:///var/run/docker.sock + refresh_interval: 5s + relabel_configs: + - source_labels: ['__meta_docker_container_name'] + regex: '/(.*)' + target_label: 'container' + - target_label: job + replacement: docker + - source_labels: ['__meta_docker_container_label_logging'] + regex: promtail + action: keep \ No newline at end of file diff --git a/app_python/pulumi/.gitignore b/app_python/pulumi/.gitignore new file mode 100644 index 0000000000..a3807e5bdb --- /dev/null +++ b/app_python/pulumi/.gitignore @@ -0,0 +1,2 @@ +*.pyc +venv/ diff --git a/app_python/pulumi/Pulumi.dev.yaml b/app_python/pulumi/Pulumi.dev.yaml new file mode 100644 index 0000000000..87ad76aa1d --- /dev/null +++ b/app_python/pulumi/Pulumi.dev.yaml @@ -0,0 +1,9 @@ +encryptionsalt: v1:ibiWcVbfzPE=:v1:JGYI/AyYOtO6LyQX:wm2sULkxKAuOHYQjzutkotLh1kDMWQ== +config: + pulumi-vm:zone: "ru-central1-a" + pulumi-vm:appPort: "1999" + pulumi-vm:sshUser: "ubuntu" + pulumi-vm:sshPublicKeyPath: "/Users/fountainer/.ssh/terraform-vm-key.pub" + yandex:cloudId: "b1g4lhssapi17vlk0t0m" + yandex:folderId: "b1gcu87lbfoq3i0quvi9" + yandex:serviceAccountKeyFile: "/Users/fountainer/.yc/pulumi-key.json" \ No newline at end of file diff --git a/app_python/pulumi/Pulumi.yaml b/app_python/pulumi/Pulumi.yaml new file mode 100644 index 0000000000..f1628db528 --- /dev/null +++ b/app_python/pulumi/Pulumi.yaml @@ -0,0 +1,11 @@ +name: pulumi-vm +description: A minimal Python Pulumi program +runtime: + name: python + options: + toolchain: pip + virtualenv: venv +config: + pulumi:tags: + value: + pulumi:template: python diff --git a/app_python/pulumi/__main__.py b/app_python/pulumi/__main__.py new file mode 100644 index 0000000000..b519111013 --- /dev/null +++ b/app_python/pulumi/__main__.py @@ -0,0 +1,64 @@ +"""A Python Pulumi program""" + +import pulumi +import pulumi_yandex as yandex +import os + +config = pulumi.Config() +zone = config.require("zone") +app_port = config.require_int("appPort") +ssh_user = config.require("sshUser") +ssh_key_path = config.require("sshPublicKeyPath") + +with open(os.path.expanduser(ssh_key_path)) as f: + public_key = f.read().strip() + +network = yandex.VpcNetwork("network", name="network") + +subnet = yandex.VpcSubnet( + "subnet", + name="subnet1", + zone=zone, + network_id=network.id, + v4_cidr_blocks=["192.168.10.0/24"] +) + +vm_sg = yandex.VpcSecurityGroup( + "vm-sg", + description="VM security group", + network_id=network.id, + ingresses=[ + yandex.VpcSecurityGroupIngressArgs(port=22, protocol="TCP", v4_cidr_blocks=["0.0.0.0/0"]), + yandex.VpcSecurityGroupIngressArgs(port=80, protocol="TCP", v4_cidr_blocks=["0.0.0.0/0"]), + yandex.VpcSecurityGroupIngressArgs(port=app_port, protocol="TCP", v4_cidr_blocks=["0.0.0.0/0"]), + ], + egresses=[ + yandex.VpcSecurityGroupEgressArgs(protocol="ANY", from_port=0, to_port=0, v4_cidr_blocks=["0.0.0.0/0"]) + ] +) + +image = yandex.get_compute_image(family="ubuntu-2204-lts") + +vm = yandex.ComputeInstance( + "vm", + name="pulumi", + zone=zone, + resources={"cores": 2, "memory": 2}, + boot_disk={ + "initialize_params": { + "name": "boot-disk", + "size": 20, + "type": "network-hdd", + "image_id": image.id, + } + }, + network_interfaces=[{ + "subnet_id": subnet.id, + "nat": True, + "security_group_ids": [vm_sg.id], + }], + metadata={"ssh-keys": f"{ssh_user}:{public_key}"} +) + +pulumi.export("internal_ip", vm.network_interfaces[0]["ip_address"]) +pulumi.export("external_ip", vm.network_interfaces[0]["nat_ip_address"]) diff --git a/app_python/pulumi/requirements.txt b/app_python/pulumi/requirements.txt new file mode 100644 index 0000000000..938e7bfb54 --- /dev/null +++ b/app_python/pulumi/requirements.txt @@ -0,0 +1,4 @@ +pulumi>=3.223.0 +pulumi_yandex==0.13.0 +PyYAML +setuptools \ No newline at end of file diff --git a/app_python/requirements.txt b/app_python/requirements.txt new file mode 100644 index 0000000000..47296a42b8 --- /dev/null +++ b/app_python/requirements.txt @@ -0,0 +1,6 @@ +# Web Framework +flask==3.1.2 +pytest==9.0.2 +python-json-logger==4.0.0 +python-dotenv==1.2.2 +prometheus-client==0.23.1 \ No newline at end of file diff --git a/app_python/terraform/.gitignore b/app_python/terraform/.gitignore new file mode 100644 index 0000000000..b7cf2bdd62 --- /dev/null +++ b/app_python/terraform/.gitignore @@ -0,0 +1,4 @@ +.terraform/ +terraform.tfstate +terraform.tfstate.backup +terraform.tfvars \ No newline at end of file diff --git a/app_python/terraform/.terraform.lock.hcl b/app_python/terraform/.terraform.lock.hcl new file mode 100644 index 0000000000..280b0e4395 --- /dev/null +++ b/app_python/terraform/.terraform.lock.hcl @@ -0,0 +1,9 @@ +# This file is maintained automatically by "terraform init". +# Manual edits may be lost in future updates. + +provider "registry.terraform.io/yandex-cloud/yandex" { + version = "0.191.0" + hashes = [ + "h1:MGHtJSlDigrSSCHWdl28B+XXnH87C82Qu0978/lbJtM=", + ] +} diff --git a/app_python/terraform/README.md b/app_python/terraform/README.md new file mode 100644 index 0000000000..22dafe1be3 --- /dev/null +++ b/app_python/terraform/README.md @@ -0,0 +1,33 @@ +## SETUP INSTRUCTIONS: TERRAFORM + +### Set environment variables +```bash +export YC_TOKEN=$(yc iam create-token --impersonate-service-account-id ) +export YC_CLOUD_ID=$(yc config get cloud-id) +export YC_FOLDER_ID=$(yc config get folder-id) +``` + +### Initialize Terraform +```bash +terraform init +``` + +### Plan infrastructure +```bash +terraform plan +``` + +### Apply infrastructure +```bash +terraform apply +``` + +### Access VM via SSH +```bash +ssh -i /path/to/terraform-vm-key ubuntu@ +``` + +### Destroy resources +```bash +terraform destroy +``` diff --git a/app_python/terraform/main.tf b/app_python/terraform/main.tf new file mode 100644 index 0000000000..6d122555f9 --- /dev/null +++ b/app_python/terraform/main.tf @@ -0,0 +1,95 @@ +terraform { + required_providers { + yandex = { + source = "yandex-cloud/yandex" + } + } + required_version = ">= 0.13" +} + +provider "yandex" { + service_account_key_file = "/Users/fountainer/.yandexcloud/my-sa-key.json" + zone = var.zone + cloud_id = "b1g4lhssapi17vlk0t0m" + folder_id = "b1gcu87lbfoq3i0quvi9" +} + +data "yandex_compute_image" "ubuntu_2204" { + family = "ubuntu-2204-lts" +} + +resource "yandex_compute_disk" "boot-disk" { + name = "boot-disk-terraform" + type = "network-hdd" + zone = var.zone + size = "20" + image_id = data.yandex_compute_image.ubuntu_2204.id +} + +resource "yandex_compute_instance" "vm" { + name = "terraform" + + resources { + cores = 2 + memory = 2 + } + + boot_disk { + disk_id = yandex_compute_disk.boot-disk.id + } + + network_interface { + subnet_id = yandex_vpc_subnet.subnet.id + nat = true + security_group_ids = [yandex_vpc_security_group.vm_sg.id] + + } + + metadata = { + ssh-keys = "ubuntu:${file(var.ssh_key_path)}" + } +} + +resource "yandex_vpc_network" "network" { + name = "network" +} + +resource "yandex_vpc_subnet" "subnet" { + name = "subnet1" + zone = var.zone + network_id = yandex_vpc_network.network.id + v4_cidr_blocks = ["192.168.10.0/24"] +} + +resource "yandex_vpc_security_group" "vm_sg" { + name = "vm-security-group" + network_id = yandex_vpc_network.network.id + + ingress { + protocol = "TCP" + description = "SSH" + port = 22 + v4_cidr_blocks = ["0.0.0.0/0"] + } + + ingress { + protocol = "TCP" + description = "HTTP" + port = 80 + v4_cidr_blocks = ["0.0.0.0/0"] + } + + ingress { + protocol = "TCP" + description = "App port" + port = var.app_port + v4_cidr_blocks = ["0.0.0.0/0"] + } + + egress { + protocol = "ANY" + description = "Allow all outgoing traffic" + v4_cidr_blocks = ["0.0.0.0/0"] + } +} + diff --git a/app_python/terraform/outputs.tf b/app_python/terraform/outputs.tf new file mode 100644 index 0000000000..17df178a5f --- /dev/null +++ b/app_python/terraform/outputs.tf @@ -0,0 +1,10 @@ +output "internal_ip_address_vm" { + description = "Internal IP address of the VM" + value = yandex_compute_instance.vm.network_interface.0.ip_address +} + +output "external_ip_address_vm" { + description = "External (public) IP address of the VM" + value = yandex_compute_instance.vm.network_interface.0.nat_ip_address +} + diff --git a/app_python/terraform/variables.tf b/app_python/terraform/variables.tf new file mode 100644 index 0000000000..c30b81c0b3 --- /dev/null +++ b/app_python/terraform/variables.tf @@ -0,0 +1,15 @@ +variable "zone" { + description = "Yandex Cloud availability zone" +} + +variable "ssh_key_path" { + description = "Path to the SSH key for VM access" +} + +variable "ssh_source_ip" { + description = "Your IP address to allow SSH access" +} + +variable "app_port" { + description = "Custom app port to open in the firewall" +} diff --git a/app_python/tests/__init__.py b/app_python/tests/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app_python/tests/test_health_endpoint.py b/app_python/tests/test_health_endpoint.py new file mode 100644 index 0000000000..74f99cefe8 --- /dev/null +++ b/app_python/tests/test_health_endpoint.py @@ -0,0 +1,40 @@ +from app import app +import pytest + + +def test_health_endpoint(): + client = app.test_client() + response = client.get("/health") + + assert ( + response.status_code == 200 + or response.status_code == 404 + or response.status_code == 500 + ) + + resp = response.get_json() + + if response.status_code == 200: + + status = resp.get("status") + assert status + assert isinstance(status, str) + + timestamp = resp.get("timestamp") + assert timestamp + assert isinstance(timestamp, str) + + uptime_seconds = resp.get("uptime_seconds") + assert uptime_seconds >= 0 + assert isinstance(uptime_seconds, int) + + elif response.status_code == 404 or response.status_code == 500: + assert isinstance(resp, dict) + + error = resp.get("error") + assert error + assert isinstance(error, str) + + message = resp.get("message") + assert message + assert isinstance(message, str) diff --git a/app_python/tests/test_home_endpoint.py b/app_python/tests/test_home_endpoint.py new file mode 100644 index 0000000000..2bd12651a9 --- /dev/null +++ b/app_python/tests/test_home_endpoint.py @@ -0,0 +1,74 @@ +from app import app +import pytest + + +def test_home_endpoint(): + client = app.test_client() + response = client.get("/") + + assert ( + response.status_code == 200 + or response.status_code == 404 + or response.status_code == 500 + ) + resp = response.get_json() + + if response.status_code == 200: + message = resp.get("message") + assert message + assert isinstance(message, dict) + + service = message.get("service") + assert service + assert isinstance(service, dict) + assert service.get("name") + assert service.get("version") + assert service.get("description") + assert service.get("framework") + assert service.get("debug status") + + system = message.get("system") + assert system + assert isinstance(system, dict) + assert system.get("hostname") + assert system.get("platform") + assert system.get("platform_version") + assert system.get("architecture") + assert system.get("cpu_count") + assert system.get("python_version") + + runtime = message.get("runtime") + assert runtime + assert isinstance(runtime, dict) + assert runtime.get("uptime_seconds") + assert runtime.get("uptime_human") + assert runtime.get("current_time") + assert runtime.get("timezone") + + request = message.get("request") + assert request + assert isinstance(request, dict) + assert request.get("client_ip") + assert request.get("port") + assert request.get("user_agent") + assert request.get("method") + assert request.get("path") + + endpoints = message.get("endpoints") + assert endpoints + assert isinstance(endpoints, list) + assert endpoints[0] + assert endpoints[0].get("path") + assert endpoints[1] + assert endpoints[1].get("path") + + elif response.status_code == 404 or response.status_code == 500: + assert isinstance(resp, dict) + + error = resp.get("error") + assert error + assert isinstance(error, str) + + message = resp.get("message") + assert message + assert isinstance(message, str) diff --git a/cloudflare/WORKERS.md b/cloudflare/WORKERS.md new file mode 100644 index 0000000000..bb77eb3bd8 --- /dev/null +++ b/cloudflare/WORKERS.md @@ -0,0 +1,215 @@ +# Documentation + +## Deployment summary + +### Worker URL + +[https://edge-api.v-levasheva.workers.dev](https://edge-api.v-levasheva.workers.dev) + +### Main routes + +/ for general app info + +/health for health status + +/edge for cloudflare edge metadata + +/counter for a persistent KV-based request counter, which shows the number of visits for / route + +/admin-check is for checking if the requester is an admin, it uses secrets API_TOKEN and ADMIN_EMAIL, and the requester should provide valid token and email in the request headers + +and also there is "Not Found" response for non-existent route + +### Configuration used + +the worker was configured using wrangler.jsonc, which defines the worker name, entrypoint (src/index.ts), compatibility date, environment variables, and resource bindings. the project uses a TypeScript Worker template and includes an APP_NAME variable binding together with a COUNTER_KV KV namespace binding used for persistent storage in the /counter endpoint. + +## Evidence + +### Screenshot of Cloudflare dashboard + +![](./../app_python/docs/screenshots/lab17-shots/dashboard.png) + +### Example /edge JSON response + +Firstly, the local testing of all endpoints (for the deployed /edge some info such as asn and httpProtocol were added): + +![](./../app_python/docs/screenshots/lab17-shots/endpoints%20local.png) + +And the /edge endpoint in the deployed worker: + +![](./../app_python/docs/screenshots/lab17-shots/edge%20deployed.png) + +### How Workers distributes execution globally? + +cloudflare workers are automatically executed on cloudflare edge locations around the world, so requests are handled close to the user without manually selecting regions. unlike traditional VM or PaaS platforms where you often deploy separately to regions, workers use cloudflare’s global network automatically, so there is no separate “deploy to 3 regions” step. + +### The difference between workers.dev, Routes, and Custom Domains + +- workers.dev is the default public cloudflare subdomain automatically provided for testing and accessing workers + +- routes are specific url endpoints that worker will provide access to + +- custom domains allow exposing the worker directly through an owned custom domain, not through a provided workers.dev + +## Configuration, Secrets & Persistence + +### Explain why plaintext vars are not suitable for secrets + +variables I added: "APP_NAME" and "COURSE_NAME" + +plaintext vars are not safe for secrets because they are stored in config and visible in repo and dashboard, so anyone can read them + +### Secrets + +I added 2 secrets: API_TOKEN and ADMIN_EMAIL. They are used in the /admin-check endpoint, where the requester can pass their access token and email and see if they can be authenticated as an admin. + +```bash +(devops) fountainer@Veronicas-MacBook-Air edge-api % npx wrangler secret list +[ + { + "name": "ADMIN_EMAIL", + "type": "secret_text" + }, + { + "name": "API_TOKEN", + "type": "secret_text" + } +] +``` + +![](./../app_python/docs/screenshots/lab17-shots/secrets.png) + +### Workers KV persistence + +### Document what you stored and how you verified it + +I stored the number of visits of the / endpoint. Each time / is visited, the counter increases by one, and visits value is updated. The value then can be accessed through the /visits endpoint. + +The persistance verification: + +![](./../app_python/docs/screenshots/lab17-shots/persistance.png) + +## Observability & Operations + +### Example log or metrics screenshot + +Logs + +![](./../app_python/docs/screenshots/lab17-shots/logs.png) + +Metrics + +![](./../app_python/docs/screenshots/lab17-shots/metrics.png) + +I looked at errors, requests, and request duration metrics for all deployed versions for the last 24 hours. + +requests: total of 192. this metrics shows how many http requests hit the Worker through all endpoints. + +errors: 0 errors. it can be confusing since I intentially hit invalid endpoint such as https://edge-api.v-levasheva.workers.dev/smth a lot of times to get error: "Not Found", but the case was that the Worker does not count 404 responses as errors, the real errors that are considered are runtime failures, which I did not have. + +request duration: 3.15 ms on average. this metric shows the latency - how much it takes to process a request and send back a response. + +### Multiple Deployments + +* I created about 10 deployments but put here last 2 for readability + +```bash +(devops) fountainer@Veronicas-MacBook-Air edge-api % npx wrangler deployments list + + ⛅️ wrangler 4.90.0 +Created: 2026-05-10T16:57:52.287Z +Author: v.levasheva@innopolis.university +Source: Unknown (deployment) +Message: - +Version(s): (100%) 4844c942-5e05-4199-999f-b54af219ed99 + Created: 2026-05-10T16:48:11.805Z + Tag: - + Message: - + +Created: 2026-05-10T17:01:05.875Z +Author: v.levasheva@innopolis.university +Source: Unknown (deployment) +Message: - +Version(s): (100%) 9f0c5465-b3c2-462d-b199-bb1a6dc23d9f + Created: 2026-05-10T17:01:03.267Z + Tag: - + Message: - +``` + +```bash +(devops) fountainer@Veronicas-MacBook-Air edge-api % npx wrangler rollback + + ⛅️ wrangler 4.90.0 +─────────────────── +├ Your current deployment has 1 version(s): +│ +│ (100%) 9f0c5465-b3c2-462d-b199-bb1a6dc23d9f +│ Created: 2026-05-10T17:01:03.267267Z +│ Tag: - +│ Message: - +│ +✔ Please provide an optional message for this rollback (120 characters max) … test rollback +│ +├  WARNING  You are about to rollback to Worker Version 4844c942-5e05-4199-999f-b54af219ed99. +│ This will immediately replace the current deployment and become the active deployment across all your deployed triggers. +│ However, your local development environment will not be affected by this rollback. +│ Rolling back to a previous deployment will not rollback any of the bound resources (Durable Object, D1, R2, KV, etc). +│ +│ (100%) 4844c942-5e05-4199-999f-b54af219ed99 +│ Created: 2026-05-10T16:48:11.805042Z +│ Tag: - +│ Message: - +│ +✔ Are you sure you want to deploy this Worker Version to 100% of traffic? … yes +Performing rollback... +│ +╰  SUCCESS  Worker Version 4844c942-5e05-4199-999f-b54af219ed99 has been deployed to 100% of traffic. + +Current Version ID: 4844c942-5e05-4199-999f-b54af219ed99 +``` + +## Kubernetes vs Cloudflare Workers Comparison + +| Aspect | Kubernetes | Cloudflare Workers | +|--------|------------|--------------------| +| Setup complexity | really high, you should create cluster setup, manifests, networking, monitoring, and scaling configuration yourself | much simpler, just write code and deploy with minimal config | +| Deployment speed | slower, containers must build and start | very fast, seconds are enough | +| Global distribution | usually requires manual configuration | automatic global edge distribution | +| Cost (for small apps) | can become expensive due to always-running release | cheaper for lightweight APIs and low traffic apps | +| State/persistence model | persistent volumes, databases, StatefulSets | stateless by default, persistence through KV | +| Control/flexibility | very high control over runtime, networking, and storage | less low-level control, but much simpler to use | +| Best use case | complex and heavy programs, projects that require customisation | edge APIs, lightweight services, and globally distributed low-latency apps | + +## When to Use Each + +### Scenarios favoring Kubernetes + +- complex applications with multiple services +- custom configuration +- long-running work processes + +### Scenarios favoring Workers + +- lightweight APIs +- edge services +- globally distributed applications with low latency requirements + +### Your recommendation + +I would use k8s and VMs for big projects that require heavy customisation, and Cloudflare Workers for lightweight apps that will benefit immensely from locating close to the users. + +## Reflection + +### What felt easier than Kubernetes? + +- to be honest, everything felt easier + +### What felt more constrained? + +- no control over networking, no customisation, no manual resource distribution and controllable scaling. + +### What changed because Workers is not a Docker host? + +- as opposed to docker, Workers provide serverless architecture, and Workers runtime model is forced. moreover, I didn't have to keep process running locally, like with docker containers, it was nice. + diff --git a/cloudflare/edge-api/.editorconfig b/cloudflare/edge-api/.editorconfig new file mode 100644 index 0000000000..a727df347a --- /dev/null +++ b/cloudflare/edge-api/.editorconfig @@ -0,0 +1,12 @@ +# http://editorconfig.org +root = true + +[*] +indent_style = tab +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.yml] +indent_style = space diff --git a/cloudflare/edge-api/.gitignore b/cloudflare/edge-api/.gitignore new file mode 100644 index 0000000000..4138168d75 --- /dev/null +++ b/cloudflare/edge-api/.gitignore @@ -0,0 +1,167 @@ +# Logs + +logs +_.log +npm-debug.log_ +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +.pnpm-debug.log* + +# Diagnostic reports (https://nodejs.org/api/report.html) + +report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json + +# Runtime data + +pids +_.pid +_.seed +\*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover + +lib-cov + +# Coverage directory used by tools like istanbul + +coverage +\*.lcov + +# nyc test coverage + +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) + +.grunt + +# Bower dependency directory (https://bower.io/) + +bower_components + +# node-waf configuration + +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) + +build/Release + +# Dependency directories + +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) + +web_modules/ + +# TypeScript cache + +\*.tsbuildinfo + +# Optional npm cache directory + +.npm + +# Optional eslint cache + +.eslintcache + +# Optional stylelint cache + +.stylelintcache + +# Microbundle cache + +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history + +.node_repl_history + +# Output of 'npm pack' + +\*.tgz + +# Yarn Integrity file + +.yarn-integrity + +# parcel-bundler cache (https://parceljs.org/) + +.cache +.parcel-cache + +# Next.js build output + +.next +out + +# Nuxt.js build / generate output + +.nuxt +dist + +# Gatsby files + +.cache/ + +# Comment in the public line in if your project uses Gatsby and not Next.js + +# https://nextjs.org/blog/next-9-1#public-directory-support + +# public + +# vuepress build output + +.vuepress/dist + +# vuepress v2.x temp and cache directory + +.temp +.cache + +# Docusaurus cache and generated files + +.docusaurus + +# Serverless directories + +.serverless/ + +# FuseBox cache + +.fusebox/ + +# DynamoDB Local files + +.dynamodb/ + +# TernJS port file + +.tern-port + +# Stores VSCode versions used for testing VSCode extensions + +.vscode-test + +# yarn v2 + +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.\* + +# wrangler project + +.dev.vars* +!.dev.vars.example +.env* +!.env.example +.wrangler/ diff --git a/cloudflare/edge-api/.prettierrc b/cloudflare/edge-api/.prettierrc new file mode 100644 index 0000000000..5c7b5d3c7a --- /dev/null +++ b/cloudflare/edge-api/.prettierrc @@ -0,0 +1,6 @@ +{ + "printWidth": 140, + "singleQuote": true, + "semi": true, + "useTabs": true +} diff --git a/cloudflare/edge-api/.vscode/settings.json b/cloudflare/edge-api/.vscode/settings.json new file mode 100644 index 0000000000..0126e59b82 --- /dev/null +++ b/cloudflare/edge-api/.vscode/settings.json @@ -0,0 +1,5 @@ +{ + "files.associations": { + "wrangler.json": "jsonc" + } +} \ No newline at end of file diff --git a/cloudflare/edge-api/package-lock.json b/cloudflare/edge-api/package-lock.json new file mode 100644 index 0000000000..7adee25cf0 --- /dev/null +++ b/cloudflare/edge-api/package-lock.json @@ -0,0 +1,2913 @@ +{ + "name": "edge-api", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "edge-api", + "version": "0.0.0", + "devDependencies": { + "@cloudflare/vitest-pool-workers": "^0.12.4", + "@types/node": "^25.6.2", + "typescript": "^5.5.2", + "vitest": "~3.2.0", + "wrangler": "^4.90.0" + } + }, + "node_modules/@cloudflare/kv-asset-handler": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/@cloudflare/kv-asset-handler/-/kv-asset-handler-0.5.0.tgz", + "integrity": "sha512-jxQYkj8dSIzc0cD6cMMNdOc1UVjqSqu8BZdor5s8cGjW2I8BjODt/kWPVdY+u9zj3ms75Q5qaZgnxUad83+eAg==", + "dev": true, + "license": "MIT OR Apache-2.0", + "engines": { + "node": ">=22.0.0" + } + }, + "node_modules/@cloudflare/unenv-preset": { + "version": "2.16.1", + "resolved": "https://registry.npmjs.org/@cloudflare/unenv-preset/-/unenv-preset-2.16.1.tgz", + "integrity": "sha512-ECxObrMfyTl5bhQf/lZCXwo5G6xX9IAUo+nDMKK4SZ8m4Jvvxp52vilxyySSWh2YTZz8+HQ07qGH/2rEom1vDw==", + "dev": true, + "license": "MIT OR Apache-2.0", + "peerDependencies": { + "unenv": "2.0.0-rc.24", + "workerd": ">1.20260305.0 <2.0.0-0" + }, + "peerDependenciesMeta": { + "workerd": { + "optional": true + } + } + }, + "node_modules/@cloudflare/vitest-pool-workers": { + "version": "0.12.21", + "resolved": "https://registry.npmjs.org/@cloudflare/vitest-pool-workers/-/vitest-pool-workers-0.12.21.tgz", + "integrity": "sha512-xqvqVR+qAhekXWaTNY36UtFFmHrz13yGUoWVGOu6LDC2ABiQqI1E1lQ3eUZY8KVB+1FXY/mP5dB6oD07XUGnPg==", + "dev": true, + "license": "MIT", + "dependencies": { + "cjs-module-lexer": "^1.2.3", + "esbuild": "0.27.3", + "miniflare": "4.20260310.0", + "wrangler": "4.72.0" + }, + "peerDependencies": { + "@vitest/runner": "2.0.x - 3.2.x", + "@vitest/snapshot": "2.0.x - 3.2.x", + "vitest": "2.0.x - 3.2.x" + } + }, + "node_modules/@cloudflare/vitest-pool-workers/node_modules/@cloudflare/kv-asset-handler": { + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/@cloudflare/kv-asset-handler/-/kv-asset-handler-0.4.2.tgz", + "integrity": "sha512-SIOD2DxrRRwQ+jgzlXCqoEFiKOFqaPjhnNTGKXSRLvp1HiOvapLaFG2kEr9dYQTYe8rKrd9uvDUzmAITeNyaHQ==", + "dev": true, + "license": "MIT OR Apache-2.0", + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@cloudflare/vitest-pool-workers/node_modules/@cloudflare/unenv-preset": { + "version": "2.15.0", + "resolved": "https://registry.npmjs.org/@cloudflare/unenv-preset/-/unenv-preset-2.15.0.tgz", + "integrity": "sha512-EGYmJaGZKWl+X8tXxcnx4v2bOZSjQeNI5dWFeXivgX9+YCT69AkzHHwlNbVpqtEUTbew8eQurpyOpeN8fg00nw==", + "dev": true, + "license": "MIT OR Apache-2.0", + "peerDependencies": { + "unenv": "2.0.0-rc.24", + "workerd": "1.20260301.1 || ~1.20260302.1 || ~1.20260303.1 || ~1.20260304.1 || >1.20260305.0 <2.0.0-0" + }, + "peerDependenciesMeta": { + "workerd": { + "optional": true + } + } + }, + "node_modules/@cloudflare/vitest-pool-workers/node_modules/wrangler": { + "version": "4.72.0", + "resolved": "https://registry.npmjs.org/wrangler/-/wrangler-4.72.0.tgz", + "integrity": "sha512-bKkb8150JGzJZJWiNB2nu/33smVfawmfYiecA6rW4XH7xS23/jqMbgpdelM34W/7a1IhR66qeQGVqTRXROtAZg==", + "dev": true, + "license": "MIT OR Apache-2.0", + "dependencies": { + "@cloudflare/kv-asset-handler": "0.4.2", + "@cloudflare/unenv-preset": "2.15.0", + "blake3-wasm": "2.1.5", + "esbuild": "0.27.3", + "miniflare": "4.20260310.0", + "path-to-regexp": "6.3.0", + "unenv": "2.0.0-rc.24", + "workerd": "1.20260310.1" + }, + "bin": { + "wrangler": "bin/wrangler.js", + "wrangler2": "bin/wrangler.js" + }, + "engines": { + "node": ">=20.0.0" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + }, + "peerDependencies": { + "@cloudflare/workers-types": "^4.20260310.1" + }, + "peerDependenciesMeta": { + "@cloudflare/workers-types": { + "optional": true + } + } + }, + "node_modules/@cloudflare/workerd-darwin-64": { + "version": "1.20260310.1", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-darwin-64/-/workerd-darwin-64-1.20260310.1.tgz", + "integrity": "sha512-hF2VpoWaMb1fiGCQJqCY6M8I+2QQqjkyY4LiDYdTL5D/w6C1l5v1zhc0/jrjdD1DXfpJtpcSMSmEPjHse4p9Ig==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=16" + } + }, + "node_modules/@cloudflare/workerd-darwin-arm64": { + "version": "1.20260310.1", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-darwin-arm64/-/workerd-darwin-arm64-1.20260310.1.tgz", + "integrity": "sha512-h/Vl3XrYYPI6yFDE27XO1QPq/1G1lKIM8tzZGIWYpntK3IN5XtH3Ee/sLaegpJ49aIJoqhF2mVAZ6Yw+Vk2gJw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=16" + } + }, + "node_modules/@cloudflare/workerd-linux-64": { + "version": "1.20260310.1", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-linux-64/-/workerd-linux-64-1.20260310.1.tgz", + "integrity": "sha512-XzQ0GZ8G5P4d74bQYOIP2Su4CLdNPpYidrInaSOuSxMw+HamsHaFrjVsrV2mPy/yk2hi6SY2yMbgKFK9YjA7vw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=16" + } + }, + "node_modules/@cloudflare/workerd-linux-arm64": { + "version": "1.20260310.1", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-linux-arm64/-/workerd-linux-arm64-1.20260310.1.tgz", + "integrity": "sha512-sxv4CxnN4ZR0uQGTFVGa0V4KTqwdej/czpIc5tYS86G8FQQoGIBiAIs2VvU7b8EROPcandxYHDBPTb+D9HIMPw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=16" + } + }, + "node_modules/@cloudflare/workerd-windows-64": { + "version": "1.20260310.1", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-windows-64/-/workerd-windows-64-1.20260310.1.tgz", + "integrity": "sha512-+1ZTViWKJypLfgH/luAHCqkent0DEBjAjvO40iAhOMHRLYP/SPphLvr4Jpi6lb+sIocS8Q1QZL4uM5Etg1Wskg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=16" + } + }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", + "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/trace-mapping": "0.3.9" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@emnapi/runtime": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.10.0.tgz", + "integrity": "sha512-ewvYlk86xUoGI0zQRNq/mC+16R1QeDlKQy21Ki3oSYXNgLb45GV1P6A0M+/s6nyCuNDqe5VpaY84BzXGwVbwFA==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.3.tgz", + "integrity": "sha512-9fJMTNFTWZMh5qwrBItuziu834eOCUcEqymSH7pY+zoMVEZg3gcPuBNxH1EvfVYe9h0x/Ptw8KBzv7qxb7l8dg==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.3.tgz", + "integrity": "sha512-i5D1hPY7GIQmXlXhs2w8AWHhenb00+GxjxRncS2ZM7YNVGNfaMxgzSGuO8o8SJzRc/oZwU2bcScvVERk03QhzA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.3.tgz", + "integrity": "sha512-YdghPYUmj/FX2SYKJ0OZxf+iaKgMsKHVPF1MAq/P8WirnSpCStzKJFjOjzsW0QQ7oIAiccHdcqjbHmJxRb/dmg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.3.tgz", + "integrity": "sha512-IN/0BNTkHtk8lkOM8JWAYFg4ORxBkZQf9zXiEOfERX/CzxW3Vg1ewAhU7QSWQpVIzTW+b8Xy+lGzdYXV6UZObQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.3.tgz", + "integrity": "sha512-Re491k7ByTVRy0t3EKWajdLIr0gz2kKKfzafkth4Q8A5n1xTHrkqZgLLjFEHVD+AXdUGgQMq+Godfq45mGpCKg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.3.tgz", + "integrity": "sha512-vHk/hA7/1AckjGzRqi6wbo+jaShzRowYip6rt6q7VYEDX4LEy1pZfDpdxCBnGtl+A5zq8iXDcyuxwtv3hNtHFg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.3.tgz", + "integrity": "sha512-ipTYM2fjt3kQAYOvo6vcxJx3nBYAzPjgTCk7QEgZG8AUO3ydUhvelmhrbOheMnGOlaSFUoHXB6un+A7q4ygY9w==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.3.tgz", + "integrity": "sha512-dDk0X87T7mI6U3K9VjWtHOXqwAMJBNN2r7bejDsc+j03SEjtD9HrOl8gVFByeM0aJksoUuUVU9TBaZa2rgj0oA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.3.tgz", + "integrity": "sha512-s6nPv2QkSupJwLYyfS+gwdirm0ukyTFNl3KTgZEAiJDd+iHZcbTPPcWCcRYH+WlNbwChgH2QkE9NSlNrMT8Gfw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.3.tgz", + "integrity": "sha512-sZOuFz/xWnZ4KH3YfFrKCf1WyPZHakVzTiqji3WDc0BCl2kBwiJLCXpzLzUBLgmp4veFZdvN5ChW4Eq/8Fc2Fg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.3.tgz", + "integrity": "sha512-yGlQYjdxtLdh0a3jHjuwOrxQjOZYD/C9PfdbgJJF3TIZWnm/tMd/RcNiLngiu4iwcBAOezdnSLAwQDPqTmtTYg==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.3.tgz", + "integrity": "sha512-WO60Sn8ly3gtzhyjATDgieJNet/KqsDlX5nRC5Y3oTFcS1l0KWba+SEa9Ja1GfDqSF1z6hif/SkpQJbL63cgOA==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.3.tgz", + "integrity": "sha512-APsymYA6sGcZ4pD6k+UxbDjOFSvPWyZhjaiPyl/f79xKxwTnrn5QUnXR5prvetuaSMsb4jgeHewIDCIWljrSxw==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.3.tgz", + "integrity": "sha512-eizBnTeBefojtDb9nSh4vvVQ3V9Qf9Df01PfawPcRzJH4gFSgrObw+LveUyDoKU3kxi5+9RJTCWlj4FjYXVPEA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.3.tgz", + "integrity": "sha512-3Emwh0r5wmfm3ssTWRQSyVhbOHvqegUDRd0WhmXKX2mkHJe1SFCMJhagUleMq+Uci34wLSipf8Lagt4LlpRFWQ==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.3.tgz", + "integrity": "sha512-pBHUx9LzXWBc7MFIEEL0yD/ZVtNgLytvx60gES28GcWMqil8ElCYR4kvbV2BDqsHOvVDRrOxGySBM9Fcv744hw==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.3.tgz", + "integrity": "sha512-Czi8yzXUWIQYAtL/2y6vogER8pvcsOsk5cpwL4Gk5nJqH5UZiVByIY8Eorm5R13gq+DQKYg0+JyQoytLQas4dA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.3.tgz", + "integrity": "sha512-sDpk0RgmTCR/5HguIZa9n9u+HVKf40fbEUt+iTzSnCaGvY9kFP0YKBWZtJaraonFnqef5SlJ8/TiPAxzyS+UoA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.3.tgz", + "integrity": "sha512-P14lFKJl/DdaE00LItAukUdZO5iqNH7+PjoBm+fLQjtxfcfFE20Xf5CrLsmZdq5LFFZzb5JMZ9grUwvtVYzjiA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.3.tgz", + "integrity": "sha512-AIcMP77AvirGbRl/UZFTq5hjXK+2wC7qFRGoHSDrZ5v5b8DK/GYpXW3CPRL53NkvDqb9D+alBiC/dV0Fb7eJcw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.3.tgz", + "integrity": "sha512-DnW2sRrBzA+YnE70LKqnM3P+z8vehfJWHXECbwBmH/CU51z6FiqTQTHFenPlHmo3a8UgpLyH3PT+87OViOh1AQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.3.tgz", + "integrity": "sha512-NinAEgr/etERPTsZJ7aEZQvvg/A6IsZG/LgZy+81wON2huV7SrK3e63dU0XhyZP4RKGyTm7aOgmQk0bGp0fy2g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.3.tgz", + "integrity": "sha512-PanZ+nEz+eWoBJ8/f8HKxTTD172SKwdXebZ0ndd953gt1HRBbhMsaNqjTyYLGLPdoWHy4zLU7bDVJztF5f3BHA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.3.tgz", + "integrity": "sha512-B2t59lWWYrbRDw/tjiWOuzSsFh1Y/E95ofKz7rIVYSQkUYBjfSgf6oeYPNWHToFRr2zx52JKApIcAS/D5TUBnA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.3.tgz", + "integrity": "sha512-QLKSFeXNS8+tHW7tZpMtjlNb7HKau0QDpwm49u0vUp9y1WOF+PEzkU84y9GqYaAVW8aH8f3GcBck26jh54cX4Q==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.3.tgz", + "integrity": "sha512-4uJGhsxuptu3OcpVAzli+/gWusVGwZZHTlS63hh++ehExkVT8SgiEf7/uC/PclrPPkLhZqGgCTjd0VWLo6xMqA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@img/colour": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@img/colour/-/colour-1.1.0.tgz", + "integrity": "sha512-Td76q7j57o/tLVdgS746cYARfSyxk8iEfRxewL9h4OMzYhbW4TAcppl0mT4eyqXddh6L/jwoM75mo7ixa/pCeQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/@img/sharp-darwin-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-arm64/-/sharp-darwin-arm64-0.34.5.tgz", + "integrity": "sha512-imtQ3WMJXbMY4fxb/Ndp6HBTNVtWCUI0WdobyheGf5+ad6xX8VIDO8u2xE4qc/fr08CKG/7dDseFtn6M6g/r3w==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-arm64": "1.2.4" + } + }, + "node_modules/@img/sharp-darwin-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-x64/-/sharp-darwin-x64-0.34.5.tgz", + "integrity": "sha512-YNEFAF/4KQ/PeW0N+r+aVVsoIY0/qxxikF2SWdp+NRkmMB7y9LBZAVqQ4yhGCm/H3H270OSykqmQMKLBhBJDEw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-x64": "1.2.4" + } + }, + "node_modules/@img/sharp-libvips-darwin-arm64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-arm64/-/sharp-libvips-darwin-arm64-1.2.4.tgz", + "integrity": "sha512-zqjjo7RatFfFoP0MkQ51jfuFZBnVE2pRiaydKJ1G/rHZvnsrHAOcQALIi9sA5co5xenQdTugCvtb1cuf78Vf4g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-darwin-x64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-x64/-/sharp-libvips-darwin-x64-1.2.4.tgz", + "integrity": "sha512-1IOd5xfVhlGwX+zXv2N93k0yMONvUlANylbJw1eTah8K/Jtpi15KC+WSiaX/nBmbm2HxRM1gZ0nSdjSsrZbGKg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-arm": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm/-/sharp-libvips-linux-arm-1.2.4.tgz", + "integrity": "sha512-bFI7xcKFELdiNCVov8e44Ia4u2byA+l3XtsAj+Q8tfCwO6BQ8iDojYdvoPMqsKDkuoOo+X6HZA0s0q11ANMQ8A==", + "cpu": [ + "arm" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-arm64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm64/-/sharp-libvips-linux-arm64-1.2.4.tgz", + "integrity": "sha512-excjX8DfsIcJ10x1Kzr4RcWe1edC9PquDRRPx3YVCvQv+U5p7Yin2s32ftzikXojb1PIFc/9Mt28/y+iRklkrw==", + "cpu": [ + "arm64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-ppc64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-ppc64/-/sharp-libvips-linux-ppc64-1.2.4.tgz", + "integrity": "sha512-FMuvGijLDYG6lW+b/UvyilUWu5Ayu+3r2d1S8notiGCIyYU/76eig1UfMmkZ7vwgOrzKzlQbFSuQfgm7GYUPpA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-riscv64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-riscv64/-/sharp-libvips-linux-riscv64-1.2.4.tgz", + "integrity": "sha512-oVDbcR4zUC0ce82teubSm+x6ETixtKZBh/qbREIOcI3cULzDyb18Sr/Wcyx7NRQeQzOiHTNbZFF1UwPS2scyGA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-s390x": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-s390x/-/sharp-libvips-linux-s390x-1.2.4.tgz", + "integrity": "sha512-qmp9VrzgPgMoGZyPvrQHqk02uyjA0/QrTO26Tqk6l4ZV0MPWIW6LTkqOIov+J1yEu7MbFQaDpwdwJKhbJvuRxQ==", + "cpu": [ + "s390x" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-x64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-x64/-/sharp-libvips-linux-x64-1.2.4.tgz", + "integrity": "sha512-tJxiiLsmHc9Ax1bz3oaOYBURTXGIRDODBqhveVHonrHJ9/+k89qbLl0bcJns+e4t4rvaNBxaEZsFtSfAdquPrw==", + "cpu": [ + "x64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linuxmusl-arm64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-arm64/-/sharp-libvips-linuxmusl-arm64-1.2.4.tgz", + "integrity": "sha512-FVQHuwx1IIuNow9QAbYUzJ+En8KcVm9Lk5+uGUQJHaZmMECZmOlix9HnH7n1TRkXMS0pGxIJokIVB9SuqZGGXw==", + "cpu": [ + "arm64" + ], + "dev": true, + "libc": [ + "musl" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linuxmusl-x64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-x64/-/sharp-libvips-linuxmusl-x64-1.2.4.tgz", + "integrity": "sha512-+LpyBk7L44ZIXwz/VYfglaX/okxezESc6UxDSoyo2Ks6Jxc4Y7sGjpgU9s4PMgqgjj1gZCylTieNamqA1MF7Dg==", + "cpu": [ + "x64" + ], + "dev": true, + "libc": [ + "musl" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-linux-arm": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm/-/sharp-linux-arm-0.34.5.tgz", + "integrity": "sha512-9dLqsvwtg1uuXBGZKsxem9595+ujv0sJ6Vi8wcTANSFpwV/GONat5eCkzQo/1O6zRIkh0m/8+5BjrRr7jDUSZw==", + "cpu": [ + "arm" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm": "1.2.4" + } + }, + "node_modules/@img/sharp-linux-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm64/-/sharp-linux-arm64-0.34.5.tgz", + "integrity": "sha512-bKQzaJRY/bkPOXyKx5EVup7qkaojECG6NLYswgktOZjaXecSAeCWiZwwiFf3/Y+O1HrauiE3FVsGxFg8c24rZg==", + "cpu": [ + "arm64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm64": "1.2.4" + } + }, + "node_modules/@img/sharp-linux-ppc64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-ppc64/-/sharp-linux-ppc64-0.34.5.tgz", + "integrity": "sha512-7zznwNaqW6YtsfrGGDA6BRkISKAAE1Jo0QdpNYXNMHu2+0dTrPflTLNkpc8l7MUP5M16ZJcUvysVWWrMefZquA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-ppc64": "1.2.4" + } + }, + "node_modules/@img/sharp-linux-riscv64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-riscv64/-/sharp-linux-riscv64-0.34.5.tgz", + "integrity": "sha512-51gJuLPTKa7piYPaVs8GmByo7/U7/7TZOq+cnXJIHZKavIRHAP77e3N2HEl3dgiqdD/w0yUfiJnII77PuDDFdw==", + "cpu": [ + "riscv64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-riscv64": "1.2.4" + } + }, + "node_modules/@img/sharp-linux-s390x": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-s390x/-/sharp-linux-s390x-0.34.5.tgz", + "integrity": "sha512-nQtCk0PdKfho3eC5MrbQoigJ2gd1CgddUMkabUj+rBevs8tZ2cULOx46E7oyX+04WGfABgIwmMC0VqieTiR4jg==", + "cpu": [ + "s390x" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-s390x": "1.2.4" + } + }, + "node_modules/@img/sharp-linux-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-x64/-/sharp-linux-x64-0.34.5.tgz", + "integrity": "sha512-MEzd8HPKxVxVenwAa+JRPwEC7QFjoPWuS5NZnBt6B3pu7EG2Ge0id1oLHZpPJdn3OQK+BQDiw9zStiHBTJQQQQ==", + "cpu": [ + "x64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-x64": "1.2.4" + } + }, + "node_modules/@img/sharp-linuxmusl-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-arm64/-/sharp-linuxmusl-arm64-0.34.5.tgz", + "integrity": "sha512-fprJR6GtRsMt6Kyfq44IsChVZeGN97gTD331weR1ex1c1rypDEABN6Tm2xa1wE6lYb5DdEnk03NZPqA7Id21yg==", + "cpu": [ + "arm64" + ], + "dev": true, + "libc": [ + "musl" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-arm64": "1.2.4" + } + }, + "node_modules/@img/sharp-linuxmusl-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-x64/-/sharp-linuxmusl-x64-0.34.5.tgz", + "integrity": "sha512-Jg8wNT1MUzIvhBFxViqrEhWDGzqymo3sV7z7ZsaWbZNDLXRJZoRGrjulp60YYtV4wfY8VIKcWidjojlLcWrd8Q==", + "cpu": [ + "x64" + ], + "dev": true, + "libc": [ + "musl" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-x64": "1.2.4" + } + }, + "node_modules/@img/sharp-wasm32": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-wasm32/-/sharp-wasm32-0.34.5.tgz", + "integrity": "sha512-OdWTEiVkY2PHwqkbBI8frFxQQFekHaSSkUIJkwzclWZe64O1X4UlUjqqqLaPbUpMOQk6FBu/HtlGXNblIs0huw==", + "cpu": [ + "wasm32" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later AND MIT", + "optional": true, + "dependencies": { + "@emnapi/runtime": "^1.7.0" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-arm64/-/sharp-win32-arm64-0.34.5.tgz", + "integrity": "sha512-WQ3AgWCWYSb2yt+IG8mnC6Jdk9Whs7O0gxphblsLvdhSpSTtmu69ZG1Gkb6NuvxsNACwiPV6cNSZNzt0KPsw7g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-ia32": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-ia32/-/sharp-win32-ia32-0.34.5.tgz", + "integrity": "sha512-FV9m/7NmeCmSHDD5j4+4pNI8Cp3aW+JvLoXcTUo0IqyjSfAZJ8dIUmijx1qaJsIiU+Hosw6xM5KijAWRJCSgNg==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-x64/-/sharp-win32-x64-0.34.5.tgz", + "integrity": "sha512-+29YMsqY2/9eFEiW93eqWnuLcWcufowXewwSNIT6UwZdUUCrM3oFjMWH/Z6/TMmb4hlFenmfAVbpWeup2jryCw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "dev": true, + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", + "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.0.3", + "@jridgewell/sourcemap-codec": "^1.4.10" + } + }, + "node_modules/@poppinss/colors": { + "version": "4.1.6", + "resolved": "https://registry.npmjs.org/@poppinss/colors/-/colors-4.1.6.tgz", + "integrity": "sha512-H9xkIdFswbS8n1d6vmRd8+c10t2Qe+rZITbbDHHkQixH5+2x1FDGmi/0K+WgWiqQFKPSlIYB7jlH6Kpfn6Fleg==", + "dev": true, + "license": "MIT", + "dependencies": { + "kleur": "^4.1.5" + } + }, + "node_modules/@poppinss/dumper": { + "version": "0.6.5", + "resolved": "https://registry.npmjs.org/@poppinss/dumper/-/dumper-0.6.5.tgz", + "integrity": "sha512-NBdYIb90J7LfOI32dOewKI1r7wnkiH6m920puQ3qHUeZkxNkQiFnXVWoE6YtFSv6QOiPPf7ys6i+HWWecDz7sw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@poppinss/colors": "^4.1.5", + "@sindresorhus/is": "^7.0.2", + "supports-color": "^10.0.0" + } + }, + "node_modules/@poppinss/exception": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/@poppinss/exception/-/exception-1.2.3.tgz", + "integrity": "sha512-dCED+QRChTVatE9ibtoaxc+WkdzOSjYTKi/+uacHWIsfodVfpsueo3+DKpgU5Px8qXjgmXkSvhXvSCz3fnP9lw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.60.3.tgz", + "integrity": "sha512-x35CNW/ANXG3hE/EZpRU8MXX1JDN86hBb2wMGAtltkz7pc6cxgjpy1OMMfDosOQ+2hWqIkag/fGok1Yady9nGw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.60.3.tgz", + "integrity": "sha512-xw3xtkDApIOGayehp2+Rz4zimfkaX65r4t47iy+ymQB2G4iJCBBfj0ogVg5jpvjpn8UWn/+q9tprxleYeNp3Hw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.60.3.tgz", + "integrity": "sha512-vo6Y5Qfpx7/5EaamIwi0WqW2+zfiusVihKatLvtN1VFVy3D13uERk/6gZLU1UiHRL6fDXqj/ELIeVRGnvcTE1g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.60.3.tgz", + "integrity": "sha512-D+0QGcZhBzTN82weOnsSlY7V7+RMmPuF1CkbxyMAGE8+ZHeUjyb76ZiWmBlCu//AQQONvxcqRbwZTajZKqjuOw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.60.3.tgz", + "integrity": "sha512-6HnvHCT7fDyj6R0Ph7A6x8dQS/S38MClRWeDLqc0MdfWkxjiu1HSDYrdPhqSILzjTIC/pnXbbJbo+ft+gy/9hQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.60.3.tgz", + "integrity": "sha512-KHLgC3WKlUYW3ShFKnnosZDOJ0xjg9zp7au3sIm2bs/tGBeC2ipmvRh/N7JKi0t9Ue20C0dpEshi8WUubg+cnA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.60.3.tgz", + "integrity": "sha512-DV6fJoxEYWJOvaZIsok7KrYl0tPvga5OZ2yvKHNNYyk/2roMLqQAbGhr78EQ5YhHpnhLKJD3S1WFusAkmUuV5g==", + "cpu": [ + "arm" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.60.3.tgz", + "integrity": "sha512-mQKoJAzvuOs6F+TZybQO4GOTSMUu7v0WdxEk24krQ/uUxXoPTtHjuaUuPmFhtBcM4K0ons8nrE3JyhTuCFtT/w==", + "cpu": [ + "arm" + ], + "dev": true, + "libc": [ + "musl" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.60.3.tgz", + "integrity": "sha512-Whjj2qoiJ6+OOJMGptTYazaJvjOJm+iKHpXQM1P3LzGjt7Ff++Tp7nH4N8J/BUA7R9IHfDyx4DJIflifwnbmIA==", + "cpu": [ + "arm64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.60.3.tgz", + "integrity": "sha512-4YTNHKqGng5+yiZt3mg77nmyuCfmNfX4fPmyUapBcIk+BdwSwmCWGXOUxhXbBEkFHtoN5boLj/5NON+u5QC9tg==", + "cpu": [ + "arm64" + ], + "dev": true, + "libc": [ + "musl" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-gnu": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.60.3.tgz", + "integrity": "sha512-SU3kNlhkpI4UqlUc2VXPGK9o886ZsSeGfMAX2ba2b8DKmMXq4AL7KUrkSWVbb7koVqx41Yczx6dx5PNargIrEA==", + "cpu": [ + "loong64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-musl": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.60.3.tgz", + "integrity": "sha512-6lDLl5h4TXpB1mTf2rQWnAk/LcXrx9vBfu/DT5TIPhvMhRWaZ5MxkIc8u4lJAmBo6klTe1ywXIUHFjylW505sg==", + "cpu": [ + "loong64" + ], + "dev": true, + "libc": [ + "musl" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.60.3.tgz", + "integrity": "sha512-BMo8bOw8evlup/8G+cj5xWtPyp93xPdyoSN16Zy90Q2QZ0ZYRhCt6ZJSwbrRzG9HApFabjwj2p25TUPDWrhzqQ==", + "cpu": [ + "ppc64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-musl": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.60.3.tgz", + "integrity": "sha512-E0L8X1dZN1/Rph+5VPF6Xj2G7JJvMACVXtamTJIDrVI44Y3K+G8gQaMEAavbqCGTa16InptiVrX6eM6pmJ+7qA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "libc": [ + "musl" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.60.3.tgz", + "integrity": "sha512-oZJ/WHaVfHUiRAtmTAeo3DcevNsVvH8mbvodjZy7D5QKvCefO371SiKRpxoDcCxB3PTRTLayWBkvmDQKTcX/sw==", + "cpu": [ + "riscv64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.60.3.tgz", + "integrity": "sha512-Dhbyh7j9FybM3YaTgaHmVALwA8AkUwTPccyCQ79TG9AJUsMQqgN1DDEZNr4+QUfwiWvLDumW5vdwzoeUF+TNxQ==", + "cpu": [ + "riscv64" + ], + "dev": true, + "libc": [ + "musl" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.60.3.tgz", + "integrity": "sha512-cJd1X5XhHHlltkaypz1UcWLA8AcoIi1aWhsvaWDskD1oz2eKCypnqvTQ8ykMNI0RSmm7NkTdSqSSD7zM0xa6Ig==", + "cpu": [ + "s390x" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.60.3.tgz", + "integrity": "sha512-DAZDBHQfG2oQuhY7mc6I3/qB4LU2fQCjRvxbDwd/Jdvb9fypP4IJ4qmtu6lNjes6B531AI8cg1aKC2di97bUxA==", + "cpu": [ + "x64" + ], + "dev": true, + "libc": [ + "glibc" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.60.3.tgz", + "integrity": "sha512-cRxsE8c13mZOh3vP+wLDxpQBRrOHDIGOWyDL93Sy0Ga8y515fBcC2pjUfFwUe5T7tqvTvWbCpg1URM/AXdWIXA==", + "cpu": [ + "x64" + ], + "dev": true, + "libc": [ + "musl" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-openbsd-x64": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.60.3.tgz", + "integrity": "sha512-QaWcIgRxqEdQdhJqW4DJctsH6HCmo5vHxY0krHSX4jMtOqfzC+dqDGuHM87bu4H8JBeibWx7jFz+h6/4C8wA5Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ] + }, + "node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.60.3.tgz", + "integrity": "sha512-AaXwSvUi3QIPtroAUw1t5yHGIyqKEXwH54WUocFolZhpGDruJcs8c+xPNDRn4XiQsS7MEwnYsHW2l0MBLDMkWg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.60.3.tgz", + "integrity": "sha512-65LAKM/bAWDqKNEelHlcHvm2V+Vfb8C6INFxQXRHCvaVN1rJfwr4NvdP4FyzUaLqWfaCGaadf6UbTm8xJeYfEg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.60.3.tgz", + "integrity": "sha512-EEM2gyhBF5MFnI6vMKdX1LAosE627RGBzIoGMdLloPZkXrUN0Ckqgr2Qi8+J3zip/8NVVro3/FjB+tjhZUgUHA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-gnu": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.60.3.tgz", + "integrity": "sha512-E5Eb5H/DpxaoXH++Qkv28RcUJboMopmdDUALBczvHMf7hNIxaDZqwY5lK12UK1BHacSmvupoEWGu+n993Z0y1A==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.60.3.tgz", + "integrity": "sha512-hPt/bgL5cE+Qp+/TPHBqptcAgPzgj46mPcg/16zNUmbQk0j+mOEQV/+Lqu8QRtDV3Ek95Q6FeFITpuhl6OTsAA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@sindresorhus/is": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-7.2.0.tgz", + "integrity": "sha512-P1Cz1dWaFfR4IR+U13mqqiGsLFf1KbayybWwdd2vfctdV6hDpUkgCY0nKOLLTMSoRd/jJNjtbqzf13K8DCCXQw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sindresorhus/is?sponsor=1" + } + }, + "node_modules/@speed-highlight/core": { + "version": "1.2.15", + "resolved": "https://registry.npmjs.org/@speed-highlight/core/-/core-1.2.15.tgz", + "integrity": "sha512-BMq1K3DsElxDWawkX6eLg9+CKJrTVGCBAWVuHXVUV2u0s2711qiChLSId6ikYPfxhdYocLNt3wWwSvDiTvFabw==", + "dev": true, + "license": "CC0-1.0" + }, + "node_modules/@types/chai": { + "version": "5.2.3", + "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", + "integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/deep-eql": "*", + "assertion-error": "^2.0.1" + } + }, + "node_modules/@types/deep-eql": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz", + "integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/estree": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.9.tgz", + "integrity": "sha512-GhdPgy1el4/ImP05X05Uw4cw2/M93BCUmnEvWZNStlCzEKME4Fkk+YpoA5OiHNQmoS7Cafb8Xa3Pya8m1Qrzeg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/node": { + "version": "25.6.2", + "resolved": "https://registry.npmjs.org/@types/node/-/node-25.6.2.tgz", + "integrity": "sha512-sokuT28dxf9JT5Kady1fsXOvI4HVpjZa95NKT5y9PNTIrs2AsobR4GFAA90ZG8M+nxVRLysCXsVj6eGC7Vbrlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~7.19.0" + } + }, + "node_modules/@vitest/expect": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.2.4.tgz", + "integrity": "sha512-Io0yyORnB6sikFlt8QW5K7slY4OjqNX9jmJQ02QDda8lyM6B5oNgVWoSoKPac8/kgnCUzuHQKrSLtu/uOqqrig==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "^5.2.2", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/mocker": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.2.4.tgz", + "integrity": "sha512-46ryTE9RZO/rfDd7pEqFl7etuyzekzEhUbTW3BvmeO/BcCMEgq59BKhek3dXDWgAj4oMK6OZi+vRr1wPW6qjEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/spy": "3.2.4", + "estree-walker": "^3.0.3", + "magic-string": "^0.30.17" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "msw": "^2.4.9", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + }, + "peerDependenciesMeta": { + "msw": { + "optional": true + }, + "vite": { + "optional": true + } + } + }, + "node_modules/@vitest/pretty-format": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.2.4.tgz", + "integrity": "sha512-IVNZik8IVRJRTr9fxlitMKeJeXFFFN0JaB9PHPGQ8NKQbGpfjlTx9zO4RefN8gp7eqjNy8nyK3NZmBzOPeIxtA==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/runner": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.2.4.tgz", + "integrity": "sha512-oukfKT9Mk41LreEW09vt45f8wx7DordoWUZMYdY/cyAk7w5TWkTRCNZYF7sX7n2wB7jyGAl74OxgwhPgKaqDMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/utils": "3.2.4", + "pathe": "^2.0.3", + "strip-literal": "^3.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/snapshot": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.2.4.tgz", + "integrity": "sha512-dEYtS7qQP2CjU27QBC5oUOxLE/v5eLkGqPE0ZKEIDGMs4vKWe7IjgLOeauHsR0D5YuuycGRO5oSRXnwnmA78fQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.2.4", + "magic-string": "^0.30.17", + "pathe": "^2.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/spy": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.2.4.tgz", + "integrity": "sha512-vAfasCOe6AIK70iP5UD11Ac4siNUNJ9i/9PZ3NKx07sG6sUxeag1LWdNrMWeKKYBLlzuK+Gn65Yd5nyL6ds+nw==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyspy": "^4.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/utils": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.2.4.tgz", + "integrity": "sha512-fB2V0JFrQSMsCo9HiSq3Ezpdv4iYaXRG1Sx8edX3MwxfyNn83mKiGzOcH+Fkxt4MHxr3y42fQi1oeAInqgX2QA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.2.4", + "loupe": "^3.1.4", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/assertion-error": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", + "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + } + }, + "node_modules/blake3-wasm": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/blake3-wasm/-/blake3-wasm-2.1.5.tgz", + "integrity": "sha512-F1+K8EbfOZE49dtoPtmxUQrpXaBIl3ICvasLh+nJta0xkz+9kF/7uet9fLnwKqhDrmj6g+6K3Tw9yQPUg2ka5g==", + "dev": true, + "license": "MIT" + }, + "node_modules/cac": { + "version": "6.7.14", + "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", + "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/chai": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/chai/-/chai-5.3.3.tgz", + "integrity": "sha512-4zNhdJD/iOjSH0A05ea+Ke6MU5mmpQcbQsSOkgdaUMJ9zTlDTD/GYlwohmIE2u0gaxHYiVHEn1Fw9mZ/ktJWgw==", + "dev": true, + "license": "MIT", + "dependencies": { + "assertion-error": "^2.0.1", + "check-error": "^2.1.1", + "deep-eql": "^5.0.1", + "loupe": "^3.1.0", + "pathval": "^2.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/check-error": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.3.tgz", + "integrity": "sha512-PAJdDJusoxnwm1VwW07VWwUN1sl7smmC3OKggvndJFadxxDRyFJBX/ggnu/KE4kQAB7a3Dp8f/YXC1FlUprWmA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 16" + } + }, + "node_modules/cjs-module-lexer": { + "version": "1.4.3", + "resolved": "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-1.4.3.tgz", + "integrity": "sha512-9z8TZaGM1pfswYeXrUpzPrkx8UnWYdhJclsiYMm6x/w5+nN+8Tf/LnAgfLGQCm59qAOxU8WwHEq2vNwF6i4j+Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/cookie": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-1.1.1.tgz", + "integrity": "sha512-ei8Aos7ja0weRpFzJnEA9UHJ/7XQmqglbRwnf2ATjcB9Wq874VKH9kfjjirM6UhU2/E5fFYadylyhFldcqSidQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/deep-eql": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", + "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/detect-libc": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.1.2.tgz", + "integrity": "sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=8" + } + }, + "node_modules/error-stack-parser-es": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/error-stack-parser-es/-/error-stack-parser-es-1.0.5.tgz", + "integrity": "sha512-5qucVt2XcuGMcEGgWI7i+yZpmpByQ8J1lHhcL7PwqCwu9FPP3VUXzT4ltHe5i2z9dePwEHcDVOAfSnHsOlCXRA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/antfu" + } + }, + "node_modules/es-module-lexer": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", + "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "dev": true, + "license": "MIT" + }, + "node_modules/esbuild": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.3.tgz", + "integrity": "sha512-8VwMnyGCONIs6cWue2IdpHxHnAjzxnw2Zr7MkVxB2vjmQ2ivqGFb4LEG3SMnv0Gb2F/G/2yA8zUaiL1gywDCCg==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.27.3", + "@esbuild/android-arm": "0.27.3", + "@esbuild/android-arm64": "0.27.3", + "@esbuild/android-x64": "0.27.3", + "@esbuild/darwin-arm64": "0.27.3", + "@esbuild/darwin-x64": "0.27.3", + "@esbuild/freebsd-arm64": "0.27.3", + "@esbuild/freebsd-x64": "0.27.3", + "@esbuild/linux-arm": "0.27.3", + "@esbuild/linux-arm64": "0.27.3", + "@esbuild/linux-ia32": "0.27.3", + "@esbuild/linux-loong64": "0.27.3", + "@esbuild/linux-mips64el": "0.27.3", + "@esbuild/linux-ppc64": "0.27.3", + "@esbuild/linux-riscv64": "0.27.3", + "@esbuild/linux-s390x": "0.27.3", + "@esbuild/linux-x64": "0.27.3", + "@esbuild/netbsd-arm64": "0.27.3", + "@esbuild/netbsd-x64": "0.27.3", + "@esbuild/openbsd-arm64": "0.27.3", + "@esbuild/openbsd-x64": "0.27.3", + "@esbuild/openharmony-arm64": "0.27.3", + "@esbuild/sunos-x64": "0.27.3", + "@esbuild/win32-arm64": "0.27.3", + "@esbuild/win32-ia32": "0.27.3", + "@esbuild/win32-x64": "0.27.3" + } + }, + "node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/expect-type": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", + "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/js-tokens": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz", + "integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/kleur": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-4.1.5.tgz", + "integrity": "sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/loupe": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.1.tgz", + "integrity": "sha512-CdzqowRJCeLU72bHvWqwRBBlLcMEtIvGrlvef74kMnV2AolS9Y8xUv1I0U/MNAWMhBlKIoyuEgoJ0t/bbwHbLQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/magic-string": { + "version": "0.30.21", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", + "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.5" + } + }, + "node_modules/miniflare": { + "version": "4.20260310.0", + "resolved": "https://registry.npmjs.org/miniflare/-/miniflare-4.20260310.0.tgz", + "integrity": "sha512-uC5vNPenFpDSj5aUU3wGSABG6UUqMr+Xs1m4AkCrTHo37F4Z6xcQw5BXqViTfPDVT/zcYH1UgTVoXhr1l6ZMXw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspotcode/source-map-support": "0.8.1", + "sharp": "^0.34.5", + "undici": "7.18.2", + "workerd": "1.20260310.1", + "ws": "8.18.0", + "youch": "4.1.0-beta.10" + }, + "bin": { + "miniflare": "bootstrap.js" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true, + "license": "MIT" + }, + "node_modules/nanoid": { + "version": "3.3.12", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.12.tgz", + "integrity": "sha512-ZB9RH/39qpq5Vu6Y+NmUaFhQR6pp+M2Xt76XBnEwDaGcVAqhlvxrl3B2bKS5D3NH3QR76v3aSrKaF/Kiy7lEtQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/path-to-regexp": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.3.0.tgz", + "integrity": "sha512-Yhpw4T9C6hPpgPeA28us07OJeqZ5EzQTkbfwuhsUg0c237RomFoETJgmp2sa3F/41gfLE6G5cqcYwznmeEeOlQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/pathe": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", + "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", + "dev": true, + "license": "MIT" + }, + "node_modules/pathval": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.1.tgz", + "integrity": "sha512-//nshmD55c46FuFw26xV/xFAaB5HF9Xdap7HJBBnrKdAd6/GxDBaNA1870O79+9ueg61cZLSVc+OaFlfmObYVQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 14.16" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", + "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/postcss": { + "version": "8.5.14", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.14.tgz", + "integrity": "sha512-SoSL4+OSEtR99LHFZQiJLkT59C5B1amGO1NzTwj7TT1qCUgUO6hxOvzkOYxD+vMrXBM3XJIKzokoERdqQq/Zmg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/rollup": { + "version": "4.60.3", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.60.3.tgz", + "integrity": "sha512-pAQK9HalE84QSm4Po3EmWIZPd3FnjkShVkiMlz1iligWYkWQ7wHYd1PF/T7QZ5TVSD6uSTon5gBVMSM4JfBV+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.60.3", + "@rollup/rollup-android-arm64": "4.60.3", + "@rollup/rollup-darwin-arm64": "4.60.3", + "@rollup/rollup-darwin-x64": "4.60.3", + "@rollup/rollup-freebsd-arm64": "4.60.3", + "@rollup/rollup-freebsd-x64": "4.60.3", + "@rollup/rollup-linux-arm-gnueabihf": "4.60.3", + "@rollup/rollup-linux-arm-musleabihf": "4.60.3", + "@rollup/rollup-linux-arm64-gnu": "4.60.3", + "@rollup/rollup-linux-arm64-musl": "4.60.3", + "@rollup/rollup-linux-loong64-gnu": "4.60.3", + "@rollup/rollup-linux-loong64-musl": "4.60.3", + "@rollup/rollup-linux-ppc64-gnu": "4.60.3", + "@rollup/rollup-linux-ppc64-musl": "4.60.3", + "@rollup/rollup-linux-riscv64-gnu": "4.60.3", + "@rollup/rollup-linux-riscv64-musl": "4.60.3", + "@rollup/rollup-linux-s390x-gnu": "4.60.3", + "@rollup/rollup-linux-x64-gnu": "4.60.3", + "@rollup/rollup-linux-x64-musl": "4.60.3", + "@rollup/rollup-openbsd-x64": "4.60.3", + "@rollup/rollup-openharmony-arm64": "4.60.3", + "@rollup/rollup-win32-arm64-msvc": "4.60.3", + "@rollup/rollup-win32-ia32-msvc": "4.60.3", + "@rollup/rollup-win32-x64-gnu": "4.60.3", + "@rollup/rollup-win32-x64-msvc": "4.60.3", + "fsevents": "~2.3.2" + } + }, + "node_modules/rollup/node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "dev": true, + "license": "MIT" + }, + "node_modules/semver": { + "version": "7.8.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.0.tgz", + "integrity": "sha512-AcM7dV/5ul4EekoQ29Agm5vri8JNqRyj39o0qpX6vDF2GZrtutZl5RwgD1XnZjiTAfncsJhMI48QQH3sN87YNA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/sharp": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.34.5.tgz", + "integrity": "sha512-Ou9I5Ft9WNcCbXrU9cMgPBcCK8LiwLqcbywW3t4oDV37n1pzpuNLsYiAV8eODnjbtQlSDwZ2cUEeQz4E54Hltg==", + "dev": true, + "hasInstallScript": true, + "license": "Apache-2.0", + "dependencies": { + "@img/colour": "^1.0.0", + "detect-libc": "^2.1.2", + "semver": "^7.7.3" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-darwin-arm64": "0.34.5", + "@img/sharp-darwin-x64": "0.34.5", + "@img/sharp-libvips-darwin-arm64": "1.2.4", + "@img/sharp-libvips-darwin-x64": "1.2.4", + "@img/sharp-libvips-linux-arm": "1.2.4", + "@img/sharp-libvips-linux-arm64": "1.2.4", + "@img/sharp-libvips-linux-ppc64": "1.2.4", + "@img/sharp-libvips-linux-riscv64": "1.2.4", + "@img/sharp-libvips-linux-s390x": "1.2.4", + "@img/sharp-libvips-linux-x64": "1.2.4", + "@img/sharp-libvips-linuxmusl-arm64": "1.2.4", + "@img/sharp-libvips-linuxmusl-x64": "1.2.4", + "@img/sharp-linux-arm": "0.34.5", + "@img/sharp-linux-arm64": "0.34.5", + "@img/sharp-linux-ppc64": "0.34.5", + "@img/sharp-linux-riscv64": "0.34.5", + "@img/sharp-linux-s390x": "0.34.5", + "@img/sharp-linux-x64": "0.34.5", + "@img/sharp-linuxmusl-arm64": "0.34.5", + "@img/sharp-linuxmusl-x64": "0.34.5", + "@img/sharp-wasm32": "0.34.5", + "@img/sharp-win32-arm64": "0.34.5", + "@img/sharp-win32-ia32": "0.34.5", + "@img/sharp-win32-x64": "0.34.5" + } + }, + "node_modules/siginfo": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", + "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", + "dev": true, + "license": "ISC" + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stackback": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", + "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", + "dev": true, + "license": "MIT" + }, + "node_modules/std-env": { + "version": "3.10.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", + "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "dev": true, + "license": "MIT" + }, + "node_modules/strip-literal": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-3.1.0.tgz", + "integrity": "sha512-8r3mkIM/2+PpjHoOtiAW8Rg3jJLHaV7xPwG+YRGrv6FP0wwk/toTpATxWYOW0BKdWwl82VT2tFYi5DlROa0Mxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "js-tokens": "^9.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/antfu" + } + }, + "node_modules/supports-color": { + "version": "10.2.2", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-10.2.2.tgz", + "integrity": "sha512-SS+jx45GF1QjgEXQx4NJZV9ImqmO2NPz5FNsIHrsDjh2YsHnawpan7SNQ1o8NuhrbHZy9AZhIoCUiCeaW/C80g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/tinybench": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", + "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyexec": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", + "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyglobby": { + "version": "0.2.16", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.16.tgz", + "integrity": "sha512-pn99VhoACYR8nFHhxqix+uvsbXineAasWm5ojXoN8xEwK5Kd3/TrhNn1wByuD52UxWRLy8pu+kRMniEi6Eq9Zg==", + "dev": true, + "license": "MIT", + "dependencies": { + "fdir": "^6.5.0", + "picomatch": "^4.0.4" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/tinypool": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", + "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^18.0.0 || >=20.0.0" + } + }, + "node_modules/tinyrainbow": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", + "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/tinyspy": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-4.0.4.tgz", + "integrity": "sha512-azl+t0z7pw/z958Gy9svOTuzqIk6xq+NSheJzn5MMWtWTFywIacg2wUlzKFGtt3cthx0r2SxMK0yzJOR0IES7Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "dev": true, + "license": "0BSD", + "optional": true + }, + "node_modules/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/undici": { + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/undici/-/undici-7.18.2.tgz", + "integrity": "sha512-y+8YjDFzWdQlSE9N5nzKMT3g4a5UBX1HKowfdXh0uvAnTaqqwqB92Jt4UXBAeKekDs5IaDKyJFR4X1gYVCgXcw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=20.18.1" + } + }, + "node_modules/undici-types": { + "version": "7.19.2", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.19.2.tgz", + "integrity": "sha512-qYVnV5OEm2AW8cJMCpdV20CDyaN3g0AjDlOGf1OW4iaDEx8MwdtChUp4zu4H0VP3nDRF/8RKWH+IPp9uW0YGZg==", + "dev": true, + "license": "MIT" + }, + "node_modules/unenv": { + "version": "2.0.0-rc.24", + "resolved": "https://registry.npmjs.org/unenv/-/unenv-2.0.0-rc.24.tgz", + "integrity": "sha512-i7qRCmY42zmCwnYlh9H2SvLEypEFGye5iRmEMKjcGi7zk9UquigRjFtTLz0TYqr0ZGLZhaMHl/foy1bZR+Cwlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "pathe": "^2.0.3" + } + }, + "node_modules/vite": { + "version": "7.3.3", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.3.tgz", + "integrity": "sha512-/4XH147Ui7OGTjg3HbdWe5arnZQSbfuRzdr9Ec7TQi5I7R+ir0Rlc9GIvD4v0XZurELqA035KVXJXpR61xhiTA==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.27.0", + "fdir": "^6.5.0", + "picomatch": "^4.0.3", + "postcss": "^8.5.6", + "rollup": "^4.43.0", + "tinyglobby": "^0.2.15" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^20.19.0 || >=22.12.0", + "jiti": ">=1.21.0", + "less": "^4.0.0", + "lightningcss": "^1.21.0", + "sass": "^1.70.0", + "sass-embedded": "^1.70.0", + "stylus": ">=0.54.8", + "sugarss": "^5.0.0", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/vite-node": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.2.4.tgz", + "integrity": "sha512-EbKSKh+bh1E1IFxeO0pg1n4dvoOTt0UDiXMd/qn++r98+jPO1xtJilvXldeuQ8giIB5IkpjCgMleHMNEsGH6pg==", + "dev": true, + "license": "MIT", + "dependencies": { + "cac": "^6.7.14", + "debug": "^4.4.1", + "es-module-lexer": "^1.7.0", + "pathe": "^2.0.3", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + }, + "bin": { + "vite-node": "vite-node.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/vitest": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.2.4.tgz", + "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "^5.2.2", + "@vitest/expect": "3.2.4", + "@vitest/mocker": "3.2.4", + "@vitest/pretty-format": "^3.2.4", + "@vitest/runner": "3.2.4", + "@vitest/snapshot": "3.2.4", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "debug": "^4.4.1", + "expect-type": "^1.2.1", + "magic-string": "^0.30.17", + "pathe": "^2.0.3", + "picomatch": "^4.0.2", + "std-env": "^3.9.0", + "tinybench": "^2.9.0", + "tinyexec": "^0.3.2", + "tinyglobby": "^0.2.14", + "tinypool": "^1.1.1", + "tinyrainbow": "^2.0.0", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0", + "vite-node": "3.2.4", + "why-is-node-running": "^2.3.0" + }, + "bin": { + "vitest": "vitest.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "@edge-runtime/vm": "*", + "@types/debug": "^4.1.12", + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "@vitest/browser": "3.2.4", + "@vitest/ui": "3.2.4", + "happy-dom": "*", + "jsdom": "*" + }, + "peerDependenciesMeta": { + "@edge-runtime/vm": { + "optional": true + }, + "@types/debug": { + "optional": true + }, + "@types/node": { + "optional": true + }, + "@vitest/browser": { + "optional": true + }, + "@vitest/ui": { + "optional": true + }, + "happy-dom": { + "optional": true + }, + "jsdom": { + "optional": true + } + } + }, + "node_modules/why-is-node-running": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", + "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", + "dev": true, + "license": "MIT", + "dependencies": { + "siginfo": "^2.0.0", + "stackback": "0.0.2" + }, + "bin": { + "why-is-node-running": "cli.js" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/workerd": { + "version": "1.20260310.1", + "resolved": "https://registry.npmjs.org/workerd/-/workerd-1.20260310.1.tgz", + "integrity": "sha512-yawXhypXXHtArikJj15HOMknNGikpBbSg2ZDe6lddUbqZnJXuCVSkgc/0ArUeVMG1jbbGvpst+REFtKwILvRTQ==", + "dev": true, + "hasInstallScript": true, + "license": "Apache-2.0", + "bin": { + "workerd": "bin/workerd" + }, + "engines": { + "node": ">=16" + }, + "optionalDependencies": { + "@cloudflare/workerd-darwin-64": "1.20260310.1", + "@cloudflare/workerd-darwin-arm64": "1.20260310.1", + "@cloudflare/workerd-linux-64": "1.20260310.1", + "@cloudflare/workerd-linux-arm64": "1.20260310.1", + "@cloudflare/workerd-windows-64": "1.20260310.1" + } + }, + "node_modules/wrangler": { + "version": "4.90.0", + "resolved": "https://registry.npmjs.org/wrangler/-/wrangler-4.90.0.tgz", + "integrity": "sha512-bmNIykl59TfCUn5xQgU7IWylSsPx3LQaPLMSAq2VQHt89CBrcj9qXQ0eYfjBCWA5XTBVgten391evt7xxtXwcA==", + "dev": true, + "license": "MIT OR Apache-2.0", + "dependencies": { + "@cloudflare/kv-asset-handler": "0.5.0", + "@cloudflare/unenv-preset": "2.16.1", + "blake3-wasm": "2.1.5", + "esbuild": "0.27.3", + "miniflare": "4.20260507.1", + "path-to-regexp": "6.3.0", + "unenv": "2.0.0-rc.24", + "workerd": "1.20260507.1" + }, + "bin": { + "wrangler": "bin/wrangler.js", + "wrangler2": "bin/wrangler.js" + }, + "engines": { + "node": ">=22.0.0" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + }, + "peerDependencies": { + "@cloudflare/workers-types": "^4.20260507.1" + }, + "peerDependenciesMeta": { + "@cloudflare/workers-types": { + "optional": true + } + } + }, + "node_modules/wrangler/node_modules/@cloudflare/workerd-darwin-64": { + "version": "1.20260507.1", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-darwin-64/-/workerd-darwin-64-1.20260507.1.tgz", + "integrity": "sha512-S85aMwcaPJUjKWDiG6iMMnioKWtPLACa6m0j/EhHR1GYfVpnxb974cBc6d25L+sf7jHWHJI2u5hGp0UTJ7MtXQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=16" + } + }, + "node_modules/wrangler/node_modules/@cloudflare/workerd-darwin-arm64": { + "version": "1.20260507.1", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-darwin-arm64/-/workerd-darwin-arm64-1.20260507.1.tgz", + "integrity": "sha512-GMEBu8Zp9Q97HLnf7bWJN4KjWpN5MxpeqdvHjBGWNl8UYprJI0k+Jkp89+Wh5S8vIon+HoVbDfOzPa7VwgL6Eg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=16" + } + }, + "node_modules/wrangler/node_modules/@cloudflare/workerd-linux-64": { + "version": "1.20260507.1", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-linux-64/-/workerd-linux-64-1.20260507.1.tgz", + "integrity": "sha512-QlrKEBdgA3uVc0Ok0Q3+0/CW0CTjgj5ySir1i1YY5FXVv0X6GpwtnB5umjunjF2MFprss+L+iFGZzxcSvMC1nA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=16" + } + }, + "node_modules/wrangler/node_modules/@cloudflare/workerd-linux-arm64": { + "version": "1.20260507.1", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-linux-arm64/-/workerd-linux-arm64-1.20260507.1.tgz", + "integrity": "sha512-eGbbupEtK2nh9V9Dhcx3vv3GTKeXqSVNgAEYVCCN0NGS9tl9HbMoHRX/4JL181FKXROMigWBCQVL//qPhsAzBQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=16" + } + }, + "node_modules/wrangler/node_modules/@cloudflare/workerd-windows-64": { + "version": "1.20260507.1", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-windows-64/-/workerd-windows-64-1.20260507.1.tgz", + "integrity": "sha512-dmClJ/E0BAcuDetQIZFqbeAXejWrG5pysGRMQ6T83Y0IW/7IAamY2zFEkAJ10I5xwZsdHuYsZtzlOxpEXpJs7A==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=16" + } + }, + "node_modules/wrangler/node_modules/miniflare": { + "version": "4.20260507.1", + "resolved": "https://registry.npmjs.org/miniflare/-/miniflare-4.20260507.1.tgz", + "integrity": "sha512-PSXBiLExTdZ4UGO/raKCHQauUpYL7F880ZRB7j0+78Rv8h7TsdN2E/iEDK9sK2Y+SPQ5wJSeAa+rDeVKoZZoEw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspotcode/source-map-support": "0.8.1", + "sharp": "^0.34.5", + "undici": "7.24.8", + "workerd": "1.20260507.1", + "ws": "8.18.0", + "youch": "4.1.0-beta.10" + }, + "bin": { + "miniflare": "bootstrap.js" + }, + "engines": { + "node": ">=22.0.0" + } + }, + "node_modules/wrangler/node_modules/undici": { + "version": "7.24.8", + "resolved": "https://registry.npmjs.org/undici/-/undici-7.24.8.tgz", + "integrity": "sha512-6KQ/+QxK49Z/p3HO6E5ZCZWNnCasyZLa5ExaVYyvPxUwKtbCPMKELJOqh7EqOle0t9cH/7d2TaaTRRa6Nhs4YQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=20.18.1" + } + }, + "node_modules/wrangler/node_modules/workerd": { + "version": "1.20260507.1", + "resolved": "https://registry.npmjs.org/workerd/-/workerd-1.20260507.1.tgz", + "integrity": "sha512-z7JhsFSe6+X1b5fUHaVpo15VM1IRMJiLofEkq8iKdCo+Veqc+FUg5lIsuz8NwePxuSKrXtO4ZQpGkQLbPVXFhg==", + "dev": true, + "hasInstallScript": true, + "license": "Apache-2.0", + "bin": { + "workerd": "bin/workerd" + }, + "engines": { + "node": ">=16" + }, + "optionalDependencies": { + "@cloudflare/workerd-darwin-64": "1.20260507.1", + "@cloudflare/workerd-darwin-arm64": "1.20260507.1", + "@cloudflare/workerd-linux-64": "1.20260507.1", + "@cloudflare/workerd-linux-arm64": "1.20260507.1", + "@cloudflare/workerd-windows-64": "1.20260507.1" + } + }, + "node_modules/ws": { + "version": "8.18.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.0.tgz", + "integrity": "sha512-8VbfWfHLbbwu3+N6OKsOMpBdT4kXPDDB9cJk2bJ6mh9ucxdlnNvH1e+roYkKmN9Nxw2yjz7VzeO9oOz2zJ04Pw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10.0.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": ">=5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/youch": { + "version": "4.1.0-beta.10", + "resolved": "https://registry.npmjs.org/youch/-/youch-4.1.0-beta.10.tgz", + "integrity": "sha512-rLfVLB4FgQneDr0dv1oddCVZmKjcJ6yX6mS4pU82Mq/Dt9a3cLZQ62pDBL4AUO+uVrCvtWz3ZFUL2HFAFJ/BXQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@poppinss/colors": "^4.1.5", + "@poppinss/dumper": "^0.6.4", + "@speed-highlight/core": "^1.2.7", + "cookie": "^1.0.2", + "youch-core": "^0.3.3" + } + }, + "node_modules/youch-core": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/youch-core/-/youch-core-0.3.3.tgz", + "integrity": "sha512-ho7XuGjLaJ2hWHoK8yFnsUGy2Y5uDpqSTq1FkHLK4/oqKtyUU1AFbOOxY4IpC9f0fTLjwYbslUz0Po5BpD1wrA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@poppinss/exception": "^1.2.2", + "error-stack-parser-es": "^1.0.5" + } + } + } +} diff --git a/cloudflare/edge-api/package.json b/cloudflare/edge-api/package.json new file mode 100644 index 0000000000..4452b7a7f3 --- /dev/null +++ b/cloudflare/edge-api/package.json @@ -0,0 +1,19 @@ +{ + "name": "edge-api", + "version": "0.0.0", + "private": true, + "scripts": { + "deploy": "wrangler deploy", + "dev": "wrangler dev", + "start": "wrangler dev", + "test": "vitest", + "cf-typegen": "wrangler types" + }, + "devDependencies": { + "@cloudflare/vitest-pool-workers": "^0.12.4", + "@types/node": "^25.6.2", + "typescript": "^5.5.2", + "vitest": "~3.2.0", + "wrangler": "^4.90.0" + } +} \ No newline at end of file diff --git a/cloudflare/edge-api/src/index.ts b/cloudflare/edge-api/src/index.ts new file mode 100644 index 0000000000..6b8ad0d63c --- /dev/null +++ b/cloudflare/edge-api/src/index.ts @@ -0,0 +1,129 @@ +/** + * Welcome to Cloudflare Workers! This is your first worker. + * + * - Run `npm run dev` in your terminal to start a development server + * - Open a browser tab at http://localhost:8787/ to see your worker in action + * - Run `npm run deploy` to publish your worker + * + * Bind resources to your worker in `wrangler.jsonc`. After adding bindings, a type definition for the + * `Env` object can be regenerated with `npm run cf-typegen`. + * + * Learn more at https://developers.cloudflare.com/workers/ + */ + +export interface Env { + COURSE_NAME: string; + APP_NAME: string; + COUNTER_KV: KVNamespace; + API_TOKEN: string; + ADMIN_EMAIL: string; +} + +function jsonResponse(data: unknown, status = 200): Response { + return new Response(JSON.stringify(data, null, 2), { + status, + headers: { + "Content-Type": "application/json", + }, + }); +} + +export default { + async fetch(request: Request, env: Env): Promise { + const url = new URL(request.url); + + if (url.pathname === "/") { + const current = await env.COUNTER_KV.get("visits"); + let count = current ? parseInt(current) : 0; + count += 1; + await env.COUNTER_KV.put("visits", count.toString()); + + console.log("request", { + path: url.pathname, + method: request.method, + colo: request.cf?.colo, + }); + + return jsonResponse({ + app: env.APP_NAME, + course: env.COURSE_NAME, + message: "Hello friend!", + framework: "Cloudflare Workers", + timestamp: new Date().toISOString(), + visits: count + }); + } + + if (url.pathname === "/health") { + console.log("request", { + path: url.pathname, + method: request.method, + colo: request.cf?.colo, + }); + return jsonResponse({ + status: "healthy", + timestamp: new Date().toISOString(), + }); + } + + if (url.pathname === "/admin-check") { + console.log("request", { + path: url.pathname, + method: request.method, + colo: request.cf?.colo, + }); + const token = request.headers.get("token"); + const email = request.headers.get("email"); + + const valid = + token === env.API_TOKEN && + email === env.ADMIN_EMAIL; + + return jsonResponse({ + valid: valid, + }); + } + + + if (url.pathname === "/edge") { + console.log("request", { + path: url.pathname, + method: request.method, + colo: request.cf?.colo, + }); + return jsonResponse({ + colo: request.cf?.colo, + country: request.cf?.country, + city: request.cf?.city, + asn: request.cf?.asn, + httpProtocol: request.cf?.httpProtocol, + tlsVersion: request.cf?.tlsVersion, + userAgent: request.headers.get("User-Agent"), + }); + } + + if (url.pathname === "/counter") { + console.log("request", { + path: url.pathname, + method: request.method, + colo: request.cf?.colo, + }); + const current = await env.COUNTER_KV.get("visits"); + let count = current ? parseInt(current) : 0; + count += 1; + + return jsonResponse({ + visits: count, + }); + } + + return jsonResponse( + { + error: "Not Found", + }, + 404 + ); + + + }, +}; \ No newline at end of file diff --git a/cloudflare/edge-api/test/env.d.ts b/cloudflare/edge-api/test/env.d.ts new file mode 100644 index 0000000000..67b3610dbc --- /dev/null +++ b/cloudflare/edge-api/test/env.d.ts @@ -0,0 +1,3 @@ +declare module "cloudflare:test" { + interface ProvidedEnv extends Env {} +} diff --git a/cloudflare/edge-api/test/index.spec.ts b/cloudflare/edge-api/test/index.spec.ts new file mode 100644 index 0000000000..017dbd0c3e --- /dev/null +++ b/cloudflare/edge-api/test/index.spec.ts @@ -0,0 +1,33 @@ +import { + env, + SELF, +} from "cloudflare:test"; + +import { describe, it, expect } from "vitest"; +import worker from "../src/index"; + +const IncomingRequest = Request; + +describe("Edge API worker", () => { + it("responds from root endpoint", async () => { + const request = new IncomingRequest("http://example.com"); + + const response = await worker.fetch(request, env); + + expect(response.status).toBe(200); + + const text = await response.text(); + + expect(text).toContain("Hello friend!"); + }); + + it("responds from integration test", async () => { + const response = await SELF.fetch("https://example.com"); + + expect(response.status).toBe(200); + + const text = await response.text(); + + expect(text).toContain("Hello friend!"); + }); +}); \ No newline at end of file diff --git a/cloudflare/edge-api/test/tsconfig.json b/cloudflare/edge-api/test/tsconfig.json new file mode 100644 index 0000000000..978ecd87b7 --- /dev/null +++ b/cloudflare/edge-api/test/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "../tsconfig.json", + "compilerOptions": { + "types": ["@cloudflare/vitest-pool-workers"] + }, + "include": ["./**/*.ts", "../worker-configuration.d.ts"], + "exclude": [] +} diff --git a/cloudflare/edge-api/tsconfig.json b/cloudflare/edge-api/tsconfig.json new file mode 100644 index 0000000000..8c98cdbece --- /dev/null +++ b/cloudflare/edge-api/tsconfig.json @@ -0,0 +1,46 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + + /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + "target": "es2024", + /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + "lib": ["es2024"], + /* Specify what JSX code is generated. */ + "jsx": "react-jsx", + + /* Specify what module code is generated. */ + "module": "es2022", + /* Specify how TypeScript looks up a file from a given module specifier. */ + "moduleResolution": "Bundler", + /* Enable importing .json files */ + "resolveJsonModule": true, + + /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */ + "allowJs": true, + /* Enable error reporting in type-checked JavaScript files. */ + "checkJs": false, + + /* Disable emitting files from a compilation. */ + "noEmit": true, + + /* Ensure that each file can be safely transpiled without relying on other imports. */ + "isolatedModules": true, + /* Allow 'import x from y' when a module doesn't have a default export. */ + "allowSyntheticDefaultImports": true, + /* Ensure that casing is correct in imports. */ + "forceConsistentCasingInFileNames": true, + + /* Enable all strict type-checking options. */ + "strict": true, + + /* Skip type checking all .d.ts files. */ + "skipLibCheck": true, + "types": [ + "./worker-configuration.d.ts", + "node" + ] + }, + "exclude": ["test"], + "include": ["worker-configuration.d.ts", "src/**/*.ts"] +} diff --git a/cloudflare/edge-api/vitest.config.mts b/cloudflare/edge-api/vitest.config.mts new file mode 100644 index 0000000000..7ccad75efa --- /dev/null +++ b/cloudflare/edge-api/vitest.config.mts @@ -0,0 +1,11 @@ +import { defineWorkersConfig } from "@cloudflare/vitest-pool-workers/config"; + +export default defineWorkersConfig({ + test: { + poolOptions: { + workers: { + wrangler: { configPath: "./wrangler.jsonc" }, + }, + }, + }, +}); diff --git a/cloudflare/edge-api/worker-configuration.d.ts b/cloudflare/edge-api/worker-configuration.d.ts new file mode 100644 index 0000000000..2e82a8c549 --- /dev/null +++ b/cloudflare/edge-api/worker-configuration.d.ts @@ -0,0 +1,13559 @@ +/* eslint-disable */ +// Generated by Wrangler by running `wrangler types` (hash: dde33b4d5fc92e4633f964a9bd2a5f64) +// Runtime types generated with workerd@1.20260507.1 2026-05-09 nodejs_compat +declare namespace Cloudflare { + interface GlobalProps { + mainModule: typeof import("./src/index"); + } + interface Env { + COUNTER_KV: KVNamespace; + APP_NAME: "my-edge-api-app"; + COURSE_NAME: "devops-core"; + } +} +interface Env extends Cloudflare.Env {} +type StringifyValues> = { + [Binding in keyof EnvType]: EnvType[Binding] extends string ? EnvType[Binding] : string; +}; +declare namespace NodeJS { + interface ProcessEnv extends StringifyValues> {} +} + +// Begin runtime types +/*! ***************************************************************************** +Copyright (c) Cloudflare. All rights reserved. +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); you may not use +this file except in compliance with the License. You may obtain a copy of the +License at http://www.apache.org/licenses/LICENSE-2.0 +THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED +WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, +MERCHANTABLITY OR NON-INFRINGEMENT. +See the Apache Version 2.0 License for specific language governing permissions +and limitations under the License. +***************************************************************************** */ +/* eslint-disable */ +// noinspection JSUnusedGlobalSymbols +declare var onmessage: never; +/** + * The **`DOMException`** interface represents an abnormal event (called an **exception**) that occurs as a result of calling a method or accessing a property of a web API. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException) + */ +declare class DOMException extends Error { + constructor(message?: string, name?: string); + /** + * The **`message`** read-only property of the a message or description associated with the given error name. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/message) + */ + readonly message: string; + /** + * The **`name`** read-only property of the one of the strings associated with an error name. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/name) + */ + readonly name: string; + /** + * The **`code`** read-only property of the DOMException interface returns one of the legacy error code constants, or `0` if none match. + * @deprecated + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/code) + */ + readonly code: number; + static readonly INDEX_SIZE_ERR: number; + static readonly DOMSTRING_SIZE_ERR: number; + static readonly HIERARCHY_REQUEST_ERR: number; + static readonly WRONG_DOCUMENT_ERR: number; + static readonly INVALID_CHARACTER_ERR: number; + static readonly NO_DATA_ALLOWED_ERR: number; + static readonly NO_MODIFICATION_ALLOWED_ERR: number; + static readonly NOT_FOUND_ERR: number; + static readonly NOT_SUPPORTED_ERR: number; + static readonly INUSE_ATTRIBUTE_ERR: number; + static readonly INVALID_STATE_ERR: number; + static readonly SYNTAX_ERR: number; + static readonly INVALID_MODIFICATION_ERR: number; + static readonly NAMESPACE_ERR: number; + static readonly INVALID_ACCESS_ERR: number; + static readonly VALIDATION_ERR: number; + static readonly TYPE_MISMATCH_ERR: number; + static readonly SECURITY_ERR: number; + static readonly NETWORK_ERR: number; + static readonly ABORT_ERR: number; + static readonly URL_MISMATCH_ERR: number; + static readonly QUOTA_EXCEEDED_ERR: number; + static readonly TIMEOUT_ERR: number; + static readonly INVALID_NODE_TYPE_ERR: number; + static readonly DATA_CLONE_ERR: number; + get stack(): any; + set stack(value: any); +} +type WorkerGlobalScopeEventMap = { + fetch: FetchEvent; + scheduled: ScheduledEvent; + queue: QueueEvent; + unhandledrejection: PromiseRejectionEvent; + rejectionhandled: PromiseRejectionEvent; +}; +declare abstract class WorkerGlobalScope extends EventTarget { + EventTarget: typeof EventTarget; +} +/* The **`console`** object provides access to the debugging console (e.g., the Web console in Firefox). * + * The **`console`** object provides access to the debugging console (e.g., the Web console in Firefox). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console) + */ +interface Console { + "assert"(condition?: boolean, ...data: any[]): void; + /** + * The **`console.clear()`** static method clears the console if possible. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/clear_static) + */ + clear(): void; + /** + * The **`console.count()`** static method logs the number of times that this particular call to `count()` has been called. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/count_static) + */ + count(label?: string): void; + /** + * The **`console.countReset()`** static method resets counter used with console/count_static. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/countReset_static) + */ + countReset(label?: string): void; + /** + * The **`console.debug()`** static method outputs a message to the console at the 'debug' log level. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/debug_static) + */ + debug(...data: any[]): void; + /** + * The **`console.dir()`** static method displays a list of the properties of the specified JavaScript object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dir_static) + */ + dir(item?: any, options?: any): void; + /** + * The **`console.dirxml()`** static method displays an interactive tree of the descendant elements of the specified XML/HTML element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dirxml_static) + */ + dirxml(...data: any[]): void; + /** + * The **`console.error()`** static method outputs a message to the console at the 'error' log level. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/error_static) + */ + error(...data: any[]): void; + /** + * The **`console.group()`** static method creates a new inline group in the Web console log, causing any subsequent console messages to be indented by an additional level, until console/groupEnd_static is called. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/group_static) + */ + group(...data: any[]): void; + /** + * The **`console.groupCollapsed()`** static method creates a new inline group in the console. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupCollapsed_static) + */ + groupCollapsed(...data: any[]): void; + /** + * The **`console.groupEnd()`** static method exits the current inline group in the console. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupEnd_static) + */ + groupEnd(): void; + /** + * The **`console.info()`** static method outputs a message to the console at the 'info' log level. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/info_static) + */ + info(...data: any[]): void; + /** + * The **`console.log()`** static method outputs a message to the console. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/log_static) + */ + log(...data: any[]): void; + /** + * The **`console.table()`** static method displays tabular data as a table. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/table_static) + */ + table(tabularData?: any, properties?: string[]): void; + /** + * The **`console.time()`** static method starts a timer you can use to track how long an operation takes. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/time_static) + */ + time(label?: string): void; + /** + * The **`console.timeEnd()`** static method stops a timer that was previously started by calling console/time_static. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeEnd_static) + */ + timeEnd(label?: string): void; + /** + * The **`console.timeLog()`** static method logs the current value of a timer that was previously started by calling console/time_static. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeLog_static) + */ + timeLog(label?: string, ...data: any[]): void; + timeStamp(label?: string): void; + /** + * The **`console.trace()`** static method outputs a stack trace to the console. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/trace_static) + */ + trace(...data: any[]): void; + /** + * The **`console.warn()`** static method outputs a warning message to the console at the 'warning' log level. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/warn_static) + */ + warn(...data: any[]): void; +} +declare const console: Console; +type BufferSource = ArrayBufferView | ArrayBuffer; +type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array; +declare namespace WebAssembly { + class CompileError extends Error { + constructor(message?: string); + } + class RuntimeError extends Error { + constructor(message?: string); + } + type ValueType = "anyfunc" | "externref" | "f32" | "f64" | "i32" | "i64" | "v128"; + interface GlobalDescriptor { + value: ValueType; + mutable?: boolean; + } + class Global { + constructor(descriptor: GlobalDescriptor, value?: any); + value: any; + valueOf(): any; + } + type ImportValue = ExportValue | number; + type ModuleImports = Record; + type Imports = Record; + type ExportValue = Function | Global | Memory | Table; + type Exports = Record; + class Instance { + constructor(module: Module, imports?: Imports); + readonly exports: Exports; + } + interface MemoryDescriptor { + initial: number; + maximum?: number; + shared?: boolean; + } + class Memory { + constructor(descriptor: MemoryDescriptor); + readonly buffer: ArrayBuffer; + grow(delta: number): number; + } + type ImportExportKind = "function" | "global" | "memory" | "table"; + interface ModuleExportDescriptor { + kind: ImportExportKind; + name: string; + } + interface ModuleImportDescriptor { + kind: ImportExportKind; + module: string; + name: string; + } + abstract class Module { + static customSections(module: Module, sectionName: string): ArrayBuffer[]; + static exports(module: Module): ModuleExportDescriptor[]; + static imports(module: Module): ModuleImportDescriptor[]; + } + type TableKind = "anyfunc" | "externref"; + interface TableDescriptor { + element: TableKind; + initial: number; + maximum?: number; + } + class Table { + constructor(descriptor: TableDescriptor, value?: any); + readonly length: number; + get(index: number): any; + grow(delta: number, value?: any): number; + set(index: number, value?: any): void; + } + function instantiate(module: Module, imports?: Imports): Promise; + function validate(bytes: BufferSource): boolean; +} +/** + * The **`ServiceWorkerGlobalScope`** interface of the Service Worker API represents the global execution context of a service worker. + * Available only in secure contexts. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ServiceWorkerGlobalScope) + */ +interface ServiceWorkerGlobalScope extends WorkerGlobalScope { + DOMException: typeof DOMException; + WorkerGlobalScope: typeof WorkerGlobalScope; + btoa(data: string): string; + atob(data: string): string; + setTimeout(callback: (...args: any[]) => void, msDelay?: number): number; + setTimeout(callback: (...args: Args) => void, msDelay?: number, ...args: Args): number; + clearTimeout(timeoutId: number | null): void; + setInterval(callback: (...args: any[]) => void, msDelay?: number): number; + setInterval(callback: (...args: Args) => void, msDelay?: number, ...args: Args): number; + clearInterval(timeoutId: number | null): void; + queueMicrotask(task: Function): void; + structuredClone(value: T, options?: StructuredSerializeOptions): T; + reportError(error: any): void; + fetch(input: RequestInfo | URL, init?: RequestInit): Promise; + self: ServiceWorkerGlobalScope; + crypto: Crypto; + caches: CacheStorage; + scheduler: Scheduler; + performance: Performance; + Cloudflare: Cloudflare; + readonly origin: string; + Event: typeof Event; + ExtendableEvent: typeof ExtendableEvent; + CustomEvent: typeof CustomEvent; + PromiseRejectionEvent: typeof PromiseRejectionEvent; + FetchEvent: typeof FetchEvent; + TailEvent: typeof TailEvent; + TraceEvent: typeof TailEvent; + ScheduledEvent: typeof ScheduledEvent; + MessageEvent: typeof MessageEvent; + CloseEvent: typeof CloseEvent; + ReadableStreamDefaultReader: typeof ReadableStreamDefaultReader; + ReadableStreamBYOBReader: typeof ReadableStreamBYOBReader; + ReadableStream: typeof ReadableStream; + WritableStream: typeof WritableStream; + WritableStreamDefaultWriter: typeof WritableStreamDefaultWriter; + TransformStream: typeof TransformStream; + ByteLengthQueuingStrategy: typeof ByteLengthQueuingStrategy; + CountQueuingStrategy: typeof CountQueuingStrategy; + ErrorEvent: typeof ErrorEvent; + MessageChannel: typeof MessageChannel; + MessagePort: typeof MessagePort; + EventSource: typeof EventSource; + ReadableStreamBYOBRequest: typeof ReadableStreamBYOBRequest; + ReadableStreamDefaultController: typeof ReadableStreamDefaultController; + ReadableByteStreamController: typeof ReadableByteStreamController; + WritableStreamDefaultController: typeof WritableStreamDefaultController; + TransformStreamDefaultController: typeof TransformStreamDefaultController; + CompressionStream: typeof CompressionStream; + DecompressionStream: typeof DecompressionStream; + TextEncoderStream: typeof TextEncoderStream; + TextDecoderStream: typeof TextDecoderStream; + Headers: typeof Headers; + Body: typeof Body; + Request: typeof Request; + Response: typeof Response; + WebSocket: typeof WebSocket; + WebSocketPair: typeof WebSocketPair; + WebSocketRequestResponsePair: typeof WebSocketRequestResponsePair; + AbortController: typeof AbortController; + AbortSignal: typeof AbortSignal; + TextDecoder: typeof TextDecoder; + TextEncoder: typeof TextEncoder; + navigator: Navigator; + Navigator: typeof Navigator; + URL: typeof URL; + URLSearchParams: typeof URLSearchParams; + URLPattern: typeof URLPattern; + Blob: typeof Blob; + File: typeof File; + FormData: typeof FormData; + Crypto: typeof Crypto; + SubtleCrypto: typeof SubtleCrypto; + CryptoKey: typeof CryptoKey; + CacheStorage: typeof CacheStorage; + Cache: typeof Cache; + FixedLengthStream: typeof FixedLengthStream; + IdentityTransformStream: typeof IdentityTransformStream; + HTMLRewriter: typeof HTMLRewriter; +} +declare function addEventListener(type: Type, handler: EventListenerOrEventListenerObject, options?: EventTargetAddEventListenerOptions | boolean): void; +declare function removeEventListener(type: Type, handler: EventListenerOrEventListenerObject, options?: EventTargetEventListenerOptions | boolean): void; +/** + * The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent) + */ +declare function dispatchEvent(event: WorkerGlobalScopeEventMap[keyof WorkerGlobalScopeEventMap]): boolean; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/btoa) */ +declare function btoa(data: string): string; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/atob) */ +declare function atob(data: string): string; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/setTimeout) */ +declare function setTimeout(callback: (...args: any[]) => void, msDelay?: number): number; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/setTimeout) */ +declare function setTimeout(callback: (...args: Args) => void, msDelay?: number, ...args: Args): number; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/clearTimeout) */ +declare function clearTimeout(timeoutId: number | null): void; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/setInterval) */ +declare function setInterval(callback: (...args: any[]) => void, msDelay?: number): number; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/setInterval) */ +declare function setInterval(callback: (...args: Args) => void, msDelay?: number, ...args: Args): number; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/clearInterval) */ +declare function clearInterval(timeoutId: number | null): void; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/queueMicrotask) */ +declare function queueMicrotask(task: Function): void; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/structuredClone) */ +declare function structuredClone(value: T, options?: StructuredSerializeOptions): T; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/reportError) */ +declare function reportError(error: any): void; +/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch) */ +declare function fetch(input: RequestInfo | URL, init?: RequestInit): Promise; +declare const self: ServiceWorkerGlobalScope; +/** +* The Web Crypto API provides a set of low-level functions for common cryptographic tasks. +* The Workers runtime implements the full surface of this API, but with some differences in +* the [supported algorithms](https://developers.cloudflare.com/workers/runtime-apis/web-crypto/#supported-algorithms) +* compared to those implemented in most browsers. +* +* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/web-crypto/) +*/ +declare const crypto: Crypto; +/** +* The Cache API allows fine grained control of reading and writing from the Cloudflare global network cache. +* +* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/) +*/ +declare const caches: CacheStorage; +declare const scheduler: Scheduler; +/** +* The Workers runtime supports a subset of the Performance API, used to measure timing and performance, +* as well as timing of subrequests and other operations. +* +* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/) +*/ +declare const performance: Performance; +declare const Cloudflare: Cloudflare; +declare const origin: string; +declare const navigator: Navigator; +interface TestController { +} +interface ExecutionContext { + waitUntil(promise: Promise): void; + passThroughOnException(): void; + readonly exports: Cloudflare.Exports; + readonly props: Props; + cache?: CacheContext; + tracing?: Tracing; +} +type ExportedHandlerFetchHandler = (request: Request>, env: Env, ctx: ExecutionContext) => Response | Promise; +type ExportedHandlerConnectHandler = (socket: Socket, env: Env, ctx: ExecutionContext) => void | Promise; +type ExportedHandlerTailHandler = (events: TraceItem[], env: Env, ctx: ExecutionContext) => void | Promise; +type ExportedHandlerTraceHandler = (traces: TraceItem[], env: Env, ctx: ExecutionContext) => void | Promise; +type ExportedHandlerTailStreamHandler = (event: TailStream.TailEvent, env: Env, ctx: ExecutionContext) => TailStream.TailEventHandlerType | Promise; +type ExportedHandlerScheduledHandler = (controller: ScheduledController, env: Env, ctx: ExecutionContext) => void | Promise; +type ExportedHandlerQueueHandler = (batch: MessageBatch, env: Env, ctx: ExecutionContext) => void | Promise; +type ExportedHandlerTestHandler = (controller: TestController, env: Env, ctx: ExecutionContext) => void | Promise; +interface ExportedHandler { + fetch?: ExportedHandlerFetchHandler; + connect?: ExportedHandlerConnectHandler; + tail?: ExportedHandlerTailHandler; + trace?: ExportedHandlerTraceHandler; + tailStream?: ExportedHandlerTailStreamHandler; + scheduled?: ExportedHandlerScheduledHandler; + test?: ExportedHandlerTestHandler; + email?: EmailExportedHandler; + queue?: ExportedHandlerQueueHandler; +} +interface StructuredSerializeOptions { + transfer?: any[]; +} +declare abstract class Navigator { + sendBeacon(url: string, body?: BodyInit): boolean; + readonly userAgent: string; + readonly hardwareConcurrency: number; + readonly platform: string; + readonly language: string; + readonly languages: string[]; +} +interface AlarmInvocationInfo { + readonly isRetry: boolean; + readonly retryCount: number; + readonly scheduledTime: number; +} +interface Cloudflare { + readonly compatibilityFlags: Record; +} +interface CachePurgeError { + code: number; + message: string; +} +interface CachePurgeResult { + success: boolean; + errors: CachePurgeError[]; +} +interface CachePurgeOptions { + tags?: string[]; + pathPrefixes?: string[]; + purgeEverything?: boolean; +} +interface CacheContext { + purge(options: CachePurgeOptions): Promise; +} +declare abstract class ColoLocalActorNamespace { + get(actorId: string): Fetcher; +} +interface DurableObject { + fetch(request: Request): Response | Promise; + connect?(socket: Socket): void | Promise; + alarm?(alarmInfo?: AlarmInvocationInfo): void | Promise; + webSocketMessage?(ws: WebSocket, message: string | ArrayBuffer): void | Promise; + webSocketClose?(ws: WebSocket, code: number, reason: string, wasClean: boolean): void | Promise; + webSocketError?(ws: WebSocket, error: unknown): void | Promise; +} +type DurableObjectStub = Fetcher & { + readonly id: DurableObjectId; + readonly name?: string; +}; +interface DurableObjectId { + toString(): string; + equals(other: DurableObjectId): boolean; + readonly name?: string; + readonly jurisdiction?: string; +} +declare abstract class DurableObjectNamespace { + newUniqueId(options?: DurableObjectNamespaceNewUniqueIdOptions): DurableObjectId; + idFromName(name: string): DurableObjectId; + idFromString(id: string): DurableObjectId; + get(id: DurableObjectId, options?: DurableObjectNamespaceGetDurableObjectOptions): DurableObjectStub; + getByName(name: string, options?: DurableObjectNamespaceGetDurableObjectOptions): DurableObjectStub; + jurisdiction(jurisdiction: DurableObjectJurisdiction): DurableObjectNamespace; +} +type DurableObjectJurisdiction = "eu" | "fedramp" | "fedramp-high"; +interface DurableObjectNamespaceNewUniqueIdOptions { + jurisdiction?: DurableObjectJurisdiction; +} +type DurableObjectLocationHint = "wnam" | "enam" | "sam" | "weur" | "eeur" | "apac" | "oc" | "afr" | "me"; +type DurableObjectRoutingMode = "primary-only"; +interface DurableObjectNamespaceGetDurableObjectOptions { + locationHint?: DurableObjectLocationHint; + routingMode?: DurableObjectRoutingMode; +} +interface DurableObjectClass<_T extends Rpc.DurableObjectBranded | undefined = undefined> { +} +interface DurableObjectState { + waitUntil(promise: Promise): void; + readonly exports: Cloudflare.Exports; + readonly props: Props; + readonly id: DurableObjectId; + readonly storage: DurableObjectStorage; + container?: Container; + facets: DurableObjectFacets; + blockConcurrencyWhile(callback: () => Promise): Promise; + acceptWebSocket(ws: WebSocket, tags?: string[]): void; + getWebSockets(tag?: string): WebSocket[]; + setWebSocketAutoResponse(maybeReqResp?: WebSocketRequestResponsePair): void; + getWebSocketAutoResponse(): WebSocketRequestResponsePair | null; + getWebSocketAutoResponseTimestamp(ws: WebSocket): Date | null; + setHibernatableWebSocketEventTimeout(timeoutMs?: number): void; + getHibernatableWebSocketEventTimeout(): number | null; + getTags(ws: WebSocket): string[]; + abort(reason?: string): void; +} +interface DurableObjectTransaction { + get(key: string, options?: DurableObjectGetOptions): Promise; + get(keys: string[], options?: DurableObjectGetOptions): Promise>; + list(options?: DurableObjectListOptions): Promise>; + put(key: string, value: T, options?: DurableObjectPutOptions): Promise; + put(entries: Record, options?: DurableObjectPutOptions): Promise; + delete(key: string, options?: DurableObjectPutOptions): Promise; + delete(keys: string[], options?: DurableObjectPutOptions): Promise; + rollback(): void; + getAlarm(options?: DurableObjectGetAlarmOptions): Promise; + setAlarm(scheduledTime: number | Date, options?: DurableObjectSetAlarmOptions): Promise; + deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise; +} +interface DurableObjectStorage { + get(key: string, options?: DurableObjectGetOptions): Promise; + get(keys: string[], options?: DurableObjectGetOptions): Promise>; + list(options?: DurableObjectListOptions): Promise>; + put(key: string, value: T, options?: DurableObjectPutOptions): Promise; + put(entries: Record, options?: DurableObjectPutOptions): Promise; + delete(key: string, options?: DurableObjectPutOptions): Promise; + delete(keys: string[], options?: DurableObjectPutOptions): Promise; + deleteAll(options?: DurableObjectPutOptions): Promise; + transaction(closure: (txn: DurableObjectTransaction) => Promise): Promise; + getAlarm(options?: DurableObjectGetAlarmOptions): Promise; + setAlarm(scheduledTime: number | Date, options?: DurableObjectSetAlarmOptions): Promise; + deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise; + sync(): Promise; + sql: SqlStorage; + kv: SyncKvStorage; + transactionSync(closure: () => T): T; + getCurrentBookmark(): Promise; + getBookmarkForTime(timestamp: number | Date): Promise; + onNextSessionRestoreBookmark(bookmark: string): Promise; +} +interface DurableObjectListOptions { + start?: string; + startAfter?: string; + end?: string; + prefix?: string; + reverse?: boolean; + limit?: number; + allowConcurrency?: boolean; + noCache?: boolean; +} +interface DurableObjectGetOptions { + allowConcurrency?: boolean; + noCache?: boolean; +} +interface DurableObjectGetAlarmOptions { + allowConcurrency?: boolean; +} +interface DurableObjectPutOptions { + allowConcurrency?: boolean; + allowUnconfirmed?: boolean; + noCache?: boolean; +} +interface DurableObjectSetAlarmOptions { + allowConcurrency?: boolean; + allowUnconfirmed?: boolean; +} +declare class WebSocketRequestResponsePair { + constructor(request: string, response: string); + get request(): string; + get response(): string; +} +interface DurableObjectFacets { + get(name: string, getStartupOptions: () => FacetStartupOptions | Promise>): Fetcher; + abort(name: string, reason: any): void; + delete(name: string): void; +} +interface FacetStartupOptions { + id?: DurableObjectId | string; + class: DurableObjectClass; +} +interface AnalyticsEngineDataset { + writeDataPoint(event?: AnalyticsEngineDataPoint): void; +} +interface AnalyticsEngineDataPoint { + indexes?: ((ArrayBuffer | string) | null)[]; + doubles?: number[]; + blobs?: ((ArrayBuffer | string) | null)[]; +} +/** + * The **`Event`** interface represents an event which takes place on an `EventTarget`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event) + */ +declare class Event { + constructor(type: string, init?: EventInit); + /** + * The **`type`** read-only property of the Event interface returns a string containing the event's type. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type) + */ + get type(): string; + /** + * The **`eventPhase`** read-only property of the being evaluated. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase) + */ + get eventPhase(): number; + /** + * The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed) + */ + get composed(): boolean; + /** + * The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles) + */ + get bubbles(): boolean; + /** + * The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable) + */ + get cancelable(): boolean; + /** + * The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented) + */ + get defaultPrevented(): boolean; + /** + * The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not. + * @deprecated + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue) + */ + get returnValue(): boolean; + /** + * The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget) + */ + get currentTarget(): EventTarget | undefined; + /** + * The read-only **`target`** property of the dispatched. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target) + */ + get target(): EventTarget | undefined; + /** + * The deprecated **`Event.srcElement`** is an alias for the Event.target property. + * @deprecated + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement) + */ + get srcElement(): EventTarget | undefined; + /** + * The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp) + */ + get timeStamp(): number; + /** + * The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted) + */ + get isTrusted(): boolean; + /** + * The **`cancelBubble`** property of the Event interface is deprecated. + * @deprecated + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble) + */ + get cancelBubble(): boolean; + /** + * The **`cancelBubble`** property of the Event interface is deprecated. + * @deprecated + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble) + */ + set cancelBubble(value: boolean); + /** + * The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation) + */ + stopImmediatePropagation(): void; + /** + * The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault) + */ + preventDefault(): void; + /** + * The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation) + */ + stopPropagation(): void; + /** + * The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath) + */ + composedPath(): EventTarget[]; + static readonly NONE: number; + static readonly CAPTURING_PHASE: number; + static readonly AT_TARGET: number; + static readonly BUBBLING_PHASE: number; +} +interface EventInit { + bubbles?: boolean; + cancelable?: boolean; + composed?: boolean; +} +type EventListener = (event: EventType) => void; +interface EventListenerObject { + handleEvent(event: EventType): void; +} +type EventListenerOrEventListenerObject = EventListener | EventListenerObject; +/** + * The **`EventTarget`** interface is implemented by objects that can receive events and may have listeners for them. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget) + */ +declare class EventTarget = Record> { + constructor(); + /** + * The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener) + */ + addEventListener(type: Type, handler: EventListenerOrEventListenerObject, options?: EventTargetAddEventListenerOptions | boolean): void; + /** + * The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener) + */ + removeEventListener(type: Type, handler: EventListenerOrEventListenerObject, options?: EventTargetEventListenerOptions | boolean): void; + /** + * The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent) + */ + dispatchEvent(event: EventMap[keyof EventMap]): boolean; +} +interface EventTargetEventListenerOptions { + capture?: boolean; +} +interface EventTargetAddEventListenerOptions { + capture?: boolean; + passive?: boolean; + once?: boolean; + signal?: AbortSignal; +} +interface EventTargetHandlerObject { + handleEvent: (event: Event) => any | undefined; +} +/** + * The **`AbortController`** interface represents a controller object that allows you to abort one or more Web requests as and when desired. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController) + */ +declare class AbortController { + constructor(); + /** + * The **`signal`** read-only property of the AbortController interface returns an AbortSignal object instance, which can be used to communicate with/abort an asynchronous operation as desired. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/signal) + */ + get signal(): AbortSignal; + /** + * The **`abort()`** method of the AbortController interface aborts an asynchronous operation before it has completed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/abort) + */ + abort(reason?: any): void; +} +/** + * The **`AbortSignal`** interface represents a signal object that allows you to communicate with an asynchronous operation (such as a fetch request) and abort it if required via an AbortController object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal) + */ +declare abstract class AbortSignal extends EventTarget { + /** + * The **`AbortSignal.abort()`** static method returns an AbortSignal that is already set as aborted (and which does not trigger an AbortSignal/abort_event event). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_static) + */ + static abort(reason?: any): AbortSignal; + /** + * The **`AbortSignal.timeout()`** static method returns an AbortSignal that will automatically abort after a specified time. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/timeout_static) + */ + static timeout(delay: number): AbortSignal; + /** + * The **`AbortSignal.any()`** static method takes an iterable of abort signals and returns an AbortSignal. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/any_static) + */ + static any(signals: AbortSignal[]): AbortSignal; + /** + * The **`aborted`** read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (`true`) or not (`false`). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/aborted) + */ + get aborted(): boolean; + /** + * The **`reason`** read-only property returns a JavaScript value that indicates the abort reason. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/reason) + */ + get reason(): any; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_event) */ + get onabort(): any | null; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_event) */ + set onabort(value: any | null); + /** + * The **`throwIfAborted()`** method throws the signal's abort AbortSignal.reason if the signal has been aborted; otherwise it does nothing. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/throwIfAborted) + */ + throwIfAborted(): void; +} +interface Scheduler { + wait(delay: number, maybeOptions?: SchedulerWaitOptions): Promise; +} +interface SchedulerWaitOptions { + signal?: AbortSignal; +} +/** + * The **`ExtendableEvent`** interface extends the lifetime of the `install` and `activate` events dispatched on the global scope as part of the service worker lifecycle. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ExtendableEvent) + */ +declare abstract class ExtendableEvent extends Event { + /** + * The **`ExtendableEvent.waitUntil()`** method tells the event dispatcher that work is ongoing. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ExtendableEvent/waitUntil) + */ + waitUntil(promise: Promise): void; +} +/** + * The **`CustomEvent`** interface represents events initialized by an application for any purpose. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent) + */ +declare class CustomEvent extends Event { + constructor(type: string, init?: CustomEventCustomEventInit); + /** + * The read-only **`detail`** property of the CustomEvent interface returns any data passed when initializing the event. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent/detail) + */ + get detail(): T; +} +interface CustomEventCustomEventInit { + bubbles?: boolean; + cancelable?: boolean; + composed?: boolean; + detail?: any; +} +/** + * The **`Blob`** interface represents a blob, which is a file-like object of immutable, raw data; they can be read as text or binary data, or converted into a ReadableStream so its methods can be used for processing the data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob) + */ +declare class Blob { + constructor(bits?: ((ArrayBuffer | ArrayBufferView) | string | Blob)[], options?: BlobOptions); + /** + * The **`size`** read-only property of the Blob interface returns the size of the Blob or File in bytes. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) + */ + get size(): number; + /** + * The **`type`** read-only property of the Blob interface returns the MIME type of the file. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) + */ + get type(): string; + /** + * The **`slice()`** method of the Blob interface creates and returns a new `Blob` object which contains data from a subset of the blob on which it's called. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) + */ + slice(start?: number, end?: number, type?: string): Blob; + /** + * The **`arrayBuffer()`** method of the Blob interface returns a Promise that resolves with the contents of the blob as binary data contained in an ArrayBuffer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/arrayBuffer) + */ + arrayBuffer(): Promise; + /** + * The **`bytes()`** method of the Blob interface returns a Promise that resolves with a Uint8Array containing the contents of the blob as an array of bytes. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/bytes) + */ + bytes(): Promise; + /** + * The **`text()`** method of the string containing the contents of the blob, interpreted as UTF-8. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) + */ + text(): Promise; + /** + * The **`stream()`** method of the Blob interface returns a ReadableStream which upon reading returns the data contained within the `Blob`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/stream) + */ + stream(): ReadableStream; +} +interface BlobOptions { + type?: string; +} +/** + * The **`File`** interface provides information about files and allows JavaScript in a web page to access their content. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/File) + */ +declare class File extends Blob { + constructor(bits: ((ArrayBuffer | ArrayBufferView) | string | Blob)[] | undefined, name: string, options?: FileOptions); + /** + * The **`name`** read-only property of the File interface returns the name of the file represented by a File object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) + */ + get name(): string; + /** + * The **`lastModified`** read-only property of the File interface provides the last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) + */ + get lastModified(): number; +} +interface FileOptions { + type?: string; + lastModified?: number; +} +/** +* The Cache API allows fine grained control of reading and writing from the Cloudflare global network cache. +* +* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/) +*/ +declare abstract class CacheStorage { + /** + * The **`open()`** method of the the Cache object matching the `cacheName`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/open) + */ + open(cacheName: string): Promise; + readonly default: Cache; +} +/** +* The Cache API allows fine grained control of reading and writing from the Cloudflare global network cache. +* +* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/) +*/ +declare abstract class Cache { + /* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/#delete) */ + delete(request: RequestInfo | URL, options?: CacheQueryOptions): Promise; + /* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/#match) */ + match(request: RequestInfo | URL, options?: CacheQueryOptions): Promise; + /* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/#put) */ + put(request: RequestInfo | URL, response: Response): Promise; +} +interface CacheQueryOptions { + ignoreMethod?: boolean; +} +/** +* The Web Crypto API provides a set of low-level functions for common cryptographic tasks. +* The Workers runtime implements the full surface of this API, but with some differences in +* the [supported algorithms](https://developers.cloudflare.com/workers/runtime-apis/web-crypto/#supported-algorithms) +* compared to those implemented in most browsers. +* +* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/web-crypto/) +*/ +declare abstract class Crypto { + /** + * The **`Crypto.subtle`** read-only property returns a cryptographic operations. + * Available only in secure contexts. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/subtle) + */ + get subtle(): SubtleCrypto; + /** + * The **`Crypto.getRandomValues()`** method lets you get cryptographically strong random values. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/getRandomValues) + */ + getRandomValues(buffer: T): T; + /** + * The **`randomUUID()`** method of the Crypto interface is used to generate a v4 UUID using a cryptographically secure random number generator. + * Available only in secure contexts. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/randomUUID) + */ + randomUUID(): string; + DigestStream: typeof DigestStream; +} +/** + * The **`SubtleCrypto`** interface of the Web Crypto API provides a number of low-level cryptographic functions. + * Available only in secure contexts. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto) + */ +declare abstract class SubtleCrypto { + /** + * The **`encrypt()`** method of the SubtleCrypto interface encrypts data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/encrypt) + */ + encrypt(algorithm: string | SubtleCryptoEncryptAlgorithm, key: CryptoKey, plainText: ArrayBuffer | ArrayBufferView): Promise; + /** + * The **`decrypt()`** method of the SubtleCrypto interface decrypts some encrypted data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/decrypt) + */ + decrypt(algorithm: string | SubtleCryptoEncryptAlgorithm, key: CryptoKey, cipherText: ArrayBuffer | ArrayBufferView): Promise; + /** + * The **`sign()`** method of the SubtleCrypto interface generates a digital signature. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/sign) + */ + sign(algorithm: string | SubtleCryptoSignAlgorithm, key: CryptoKey, data: ArrayBuffer | ArrayBufferView): Promise; + /** + * The **`verify()`** method of the SubtleCrypto interface verifies a digital signature. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/verify) + */ + verify(algorithm: string | SubtleCryptoSignAlgorithm, key: CryptoKey, signature: ArrayBuffer | ArrayBufferView, data: ArrayBuffer | ArrayBufferView): Promise; + /** + * The **`digest()`** method of the SubtleCrypto interface generates a _digest_ of the given data, using the specified hash function. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/digest) + */ + digest(algorithm: string | SubtleCryptoHashAlgorithm, data: ArrayBuffer | ArrayBufferView): Promise; + /** + * The **`generateKey()`** method of the SubtleCrypto interface is used to generate a new key (for symmetric algorithms) or key pair (for public-key algorithms). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/generateKey) + */ + generateKey(algorithm: string | SubtleCryptoGenerateKeyAlgorithm, extractable: boolean, keyUsages: string[]): Promise; + /** + * The **`deriveKey()`** method of the SubtleCrypto interface can be used to derive a secret key from a master key. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveKey) + */ + deriveKey(algorithm: string | SubtleCryptoDeriveKeyAlgorithm, baseKey: CryptoKey, derivedKeyAlgorithm: string | SubtleCryptoImportKeyAlgorithm, extractable: boolean, keyUsages: string[]): Promise; + /** + * The **`deriveBits()`** method of the key. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveBits) + */ + deriveBits(algorithm: string | SubtleCryptoDeriveKeyAlgorithm, baseKey: CryptoKey, length?: number | null): Promise; + /** + * The **`importKey()`** method of the SubtleCrypto interface imports a key: that is, it takes as input a key in an external, portable format and gives you a CryptoKey object that you can use in the Web Crypto API. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/importKey) + */ + importKey(format: string, keyData: (ArrayBuffer | ArrayBufferView) | JsonWebKey, algorithm: string | SubtleCryptoImportKeyAlgorithm, extractable: boolean, keyUsages: string[]): Promise; + /** + * The **`exportKey()`** method of the SubtleCrypto interface exports a key: that is, it takes as input a CryptoKey object and gives you the key in an external, portable format. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/exportKey) + */ + exportKey(format: string, key: CryptoKey): Promise; + /** + * The **`wrapKey()`** method of the SubtleCrypto interface 'wraps' a key. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/wrapKey) + */ + wrapKey(format: string, key: CryptoKey, wrappingKey: CryptoKey, wrapAlgorithm: string | SubtleCryptoEncryptAlgorithm): Promise; + /** + * The **`unwrapKey()`** method of the SubtleCrypto interface 'unwraps' a key. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/unwrapKey) + */ + unwrapKey(format: string, wrappedKey: ArrayBuffer | ArrayBufferView, unwrappingKey: CryptoKey, unwrapAlgorithm: string | SubtleCryptoEncryptAlgorithm, unwrappedKeyAlgorithm: string | SubtleCryptoImportKeyAlgorithm, extractable: boolean, keyUsages: string[]): Promise; + timingSafeEqual(a: ArrayBuffer | ArrayBufferView, b: ArrayBuffer | ArrayBufferView): boolean; +} +/** + * The **`CryptoKey`** interface of the Web Crypto API represents a cryptographic key obtained from one of the SubtleCrypto methods SubtleCrypto.generateKey, SubtleCrypto.deriveKey, SubtleCrypto.importKey, or SubtleCrypto.unwrapKey. + * Available only in secure contexts. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey) + */ +declare abstract class CryptoKey { + /** + * The read-only **`type`** property of the CryptoKey interface indicates which kind of key is represented by the object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/type) + */ + readonly type: string; + /** + * The read-only **`extractable`** property of the CryptoKey interface indicates whether or not the key may be extracted using `SubtleCrypto.exportKey()` or `SubtleCrypto.wrapKey()`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/extractable) + */ + readonly extractable: boolean; + /** + * The read-only **`algorithm`** property of the CryptoKey interface returns an object describing the algorithm for which this key can be used, and any associated extra parameters. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/algorithm) + */ + readonly algorithm: CryptoKeyKeyAlgorithm | CryptoKeyAesKeyAlgorithm | CryptoKeyHmacKeyAlgorithm | CryptoKeyRsaKeyAlgorithm | CryptoKeyEllipticKeyAlgorithm | CryptoKeyArbitraryKeyAlgorithm; + /** + * The read-only **`usages`** property of the CryptoKey interface indicates what can be done with the key. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/usages) + */ + readonly usages: string[]; +} +interface CryptoKeyPair { + publicKey: CryptoKey; + privateKey: CryptoKey; +} +interface JsonWebKey { + kty: string; + use?: string; + key_ops?: string[]; + alg?: string; + ext?: boolean; + crv?: string; + x?: string; + y?: string; + d?: string; + n?: string; + e?: string; + p?: string; + q?: string; + dp?: string; + dq?: string; + qi?: string; + oth?: RsaOtherPrimesInfo[]; + k?: string; +} +interface RsaOtherPrimesInfo { + r?: string; + d?: string; + t?: string; +} +interface SubtleCryptoDeriveKeyAlgorithm { + name: string; + salt?: (ArrayBuffer | ArrayBufferView); + iterations?: number; + hash?: (string | SubtleCryptoHashAlgorithm); + $public?: CryptoKey; + info?: (ArrayBuffer | ArrayBufferView); +} +interface SubtleCryptoEncryptAlgorithm { + name: string; + iv?: (ArrayBuffer | ArrayBufferView); + additionalData?: (ArrayBuffer | ArrayBufferView); + tagLength?: number; + counter?: (ArrayBuffer | ArrayBufferView); + length?: number; + label?: (ArrayBuffer | ArrayBufferView); +} +interface SubtleCryptoGenerateKeyAlgorithm { + name: string; + hash?: (string | SubtleCryptoHashAlgorithm); + modulusLength?: number; + publicExponent?: (ArrayBuffer | ArrayBufferView); + length?: number; + namedCurve?: string; +} +interface SubtleCryptoHashAlgorithm { + name: string; +} +interface SubtleCryptoImportKeyAlgorithm { + name: string; + hash?: (string | SubtleCryptoHashAlgorithm); + length?: number; + namedCurve?: string; + compressed?: boolean; +} +interface SubtleCryptoSignAlgorithm { + name: string; + hash?: (string | SubtleCryptoHashAlgorithm); + dataLength?: number; + saltLength?: number; +} +interface CryptoKeyKeyAlgorithm { + name: string; +} +interface CryptoKeyAesKeyAlgorithm { + name: string; + length: number; +} +interface CryptoKeyHmacKeyAlgorithm { + name: string; + hash: CryptoKeyKeyAlgorithm; + length: number; +} +interface CryptoKeyRsaKeyAlgorithm { + name: string; + modulusLength: number; + publicExponent: ArrayBuffer | ArrayBufferView; + hash?: CryptoKeyKeyAlgorithm; +} +interface CryptoKeyEllipticKeyAlgorithm { + name: string; + namedCurve: string; +} +interface CryptoKeyArbitraryKeyAlgorithm { + name: string; + hash?: CryptoKeyKeyAlgorithm; + namedCurve?: string; + length?: number; +} +declare class DigestStream extends WritableStream { + constructor(algorithm: string | SubtleCryptoHashAlgorithm); + readonly digest: Promise; + get bytesWritten(): number | bigint; +} +/** + * The **`TextDecoder`** interface represents a decoder for a specific text encoding, such as `UTF-8`, `ISO-8859-2`, `KOI8-R`, `GBK`, etc. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextDecoder) + */ +declare class TextDecoder { + constructor(label?: string, options?: TextDecoderConstructorOptions); + /** + * The **`TextDecoder.decode()`** method returns a string containing text decoded from the buffer passed as a parameter. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextDecoder/decode) + */ + decode(input?: (ArrayBuffer | ArrayBufferView), options?: TextDecoderDecodeOptions): string; + get encoding(): string; + get fatal(): boolean; + get ignoreBOM(): boolean; +} +/** + * The **`TextEncoder`** interface takes a stream of code points as input and emits a stream of UTF-8 bytes. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoder) + */ +declare class TextEncoder { + constructor(); + /** + * The **`TextEncoder.encode()`** method takes a string as input, and returns a Global_Objects/Uint8Array containing the text given in parameters encoded with the specific method for that TextEncoder object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoder/encode) + */ + encode(input?: string): Uint8Array; + /** + * The **`TextEncoder.encodeInto()`** method takes a string to encode and a destination Uint8Array to put resulting UTF-8 encoded text into, and returns a dictionary object indicating the progress of the encoding. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoder/encodeInto) + */ + encodeInto(input: string, buffer: Uint8Array): TextEncoderEncodeIntoResult; + get encoding(): string; +} +interface TextDecoderConstructorOptions { + fatal: boolean; + ignoreBOM: boolean; +} +interface TextDecoderDecodeOptions { + stream: boolean; +} +interface TextEncoderEncodeIntoResult { + read: number; + written: number; +} +/** + * The **`ErrorEvent`** interface represents events providing information related to errors in scripts or in files. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent) + */ +declare class ErrorEvent extends Event { + constructor(type: string, init?: ErrorEventErrorEventInit); + /** + * The **`filename`** read-only property of the ErrorEvent interface returns a string containing the name of the script file in which the error occurred. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/filename) + */ + get filename(): string; + /** + * The **`message`** read-only property of the ErrorEvent interface returns a string containing a human-readable error message describing the problem. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/message) + */ + get message(): string; + /** + * The **`lineno`** read-only property of the ErrorEvent interface returns an integer containing the line number of the script file on which the error occurred. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/lineno) + */ + get lineno(): number; + /** + * The **`colno`** read-only property of the ErrorEvent interface returns an integer containing the column number of the script file on which the error occurred. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/colno) + */ + get colno(): number; + /** + * The **`error`** read-only property of the ErrorEvent interface returns a JavaScript value, such as an Error or DOMException, representing the error associated with this event. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/error) + */ + get error(): any; +} +interface ErrorEventErrorEventInit { + message?: string; + filename?: string; + lineno?: number; + colno?: number; + error?: any; +} +/** + * The **`MessageEvent`** interface represents a message received by a target object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent) + */ +declare class MessageEvent extends Event { + constructor(type: string, initializer: MessageEventInit); + /** + * The **`data`** read-only property of the The data sent by the message emitter; this can be any data type, depending on what originated this event. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/data) + */ + readonly data: any; + /** + * The **`origin`** read-only property of the origin of the message emitter. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/origin) + */ + readonly origin: string | null; + /** + * The **`lastEventId`** read-only property of the unique ID for the event. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/lastEventId) + */ + readonly lastEventId: string; + /** + * The **`source`** read-only property of the a WindowProxy, MessagePort, or a `MessageEventSource` (which can be a WindowProxy, message emitter. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/source) + */ + readonly source: MessagePort | null; + /** + * The **`ports`** read-only property of the containing all MessagePort objects sent with the message, in order. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/ports) + */ + readonly ports: MessagePort[]; +} +interface MessageEventInit { + data: ArrayBuffer | string; +} +/** + * The **`PromiseRejectionEvent`** interface represents events which are sent to the global script context when JavaScript Promises are rejected. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent) + */ +declare abstract class PromiseRejectionEvent extends Event { + /** + * The PromiseRejectionEvent interface's **`promise`** read-only property indicates the JavaScript rejected. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent/promise) + */ + readonly promise: Promise; + /** + * The PromiseRejectionEvent **`reason`** read-only property is any JavaScript value or Object which provides the reason passed into Promise.reject(). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent/reason) + */ + readonly reason: any; +} +/** + * The **`FormData`** interface provides a way to construct a set of key/value pairs representing form fields and their values, which can be sent using the Window/fetch, XMLHttpRequest.send() or navigator.sendBeacon() methods. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData) + */ +declare class FormData { + constructor(); + /** + * The **`append()`** method of the FormData interface appends a new value onto an existing key inside a `FormData` object, or adds the key if it does not already exist. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/append) + */ + append(name: string, value: string | Blob): void; + /** + * The **`append()`** method of the FormData interface appends a new value onto an existing key inside a `FormData` object, or adds the key if it does not already exist. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/append) + */ + append(name: string, value: string): void; + /** + * The **`append()`** method of the FormData interface appends a new value onto an existing key inside a `FormData` object, or adds the key if it does not already exist. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/append) + */ + append(name: string, value: Blob, filename?: string): void; + /** + * The **`delete()`** method of the FormData interface deletes a key and its value(s) from a `FormData` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/delete) + */ + delete(name: string): void; + /** + * The **`get()`** method of the FormData interface returns the first value associated with a given key from within a `FormData` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/get) + */ + get(name: string): (File | string) | null; + /** + * The **`getAll()`** method of the FormData interface returns all the values associated with a given key from within a `FormData` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/getAll) + */ + getAll(name: string): (File | string)[]; + /** + * The **`has()`** method of the FormData interface returns whether a `FormData` object contains a certain key. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/has) + */ + has(name: string): boolean; + /** + * The **`set()`** method of the FormData interface sets a new value for an existing key inside a `FormData` object, or adds the key/value if it does not already exist. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/set) + */ + set(name: string, value: string | Blob): void; + /** + * The **`set()`** method of the FormData interface sets a new value for an existing key inside a `FormData` object, or adds the key/value if it does not already exist. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/set) + */ + set(name: string, value: string): void; + /** + * The **`set()`** method of the FormData interface sets a new value for an existing key inside a `FormData` object, or adds the key/value if it does not already exist. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/set) + */ + set(name: string, value: Blob, filename?: string): void; + /* Returns an array of key, value pairs for every entry in the list. */ + entries(): IterableIterator<[ + key: string, + value: File | string + ]>; + /* Returns a list of keys in the list. */ + keys(): IterableIterator; + /* Returns a list of values in the list. */ + values(): IterableIterator<(File | string)>; + forEach(callback: (this: This, value: File | string, key: string, parent: FormData) => void, thisArg?: This): void; + [Symbol.iterator](): IterableIterator<[ + key: string, + value: File | string + ]>; +} +interface ContentOptions { + html?: boolean; +} +declare class HTMLRewriter { + constructor(); + on(selector: string, handlers: HTMLRewriterElementContentHandlers): HTMLRewriter; + onDocument(handlers: HTMLRewriterDocumentContentHandlers): HTMLRewriter; + transform(response: Response): Response; +} +interface HTMLRewriterElementContentHandlers { + element?(element: Element): void | Promise; + comments?(comment: Comment): void | Promise; + text?(element: Text): void | Promise; +} +interface HTMLRewriterDocumentContentHandlers { + doctype?(doctype: Doctype): void | Promise; + comments?(comment: Comment): void | Promise; + text?(text: Text): void | Promise; + end?(end: DocumentEnd): void | Promise; +} +interface Doctype { + readonly name: string | null; + readonly publicId: string | null; + readonly systemId: string | null; +} +interface Element { + tagName: string; + readonly attributes: IterableIterator; + readonly removed: boolean; + readonly namespaceURI: string; + getAttribute(name: string): string | null; + hasAttribute(name: string): boolean; + setAttribute(name: string, value: string): Element; + removeAttribute(name: string): Element; + before(content: string | ReadableStream | Response, options?: ContentOptions): Element; + after(content: string | ReadableStream | Response, options?: ContentOptions): Element; + prepend(content: string | ReadableStream | Response, options?: ContentOptions): Element; + append(content: string | ReadableStream | Response, options?: ContentOptions): Element; + replace(content: string | ReadableStream | Response, options?: ContentOptions): Element; + remove(): Element; + removeAndKeepContent(): Element; + setInnerContent(content: string | ReadableStream | Response, options?: ContentOptions): Element; + onEndTag(handler: (tag: EndTag) => void | Promise): void; +} +interface EndTag { + name: string; + before(content: string | ReadableStream | Response, options?: ContentOptions): EndTag; + after(content: string | ReadableStream | Response, options?: ContentOptions): EndTag; + remove(): EndTag; +} +interface Comment { + text: string; + readonly removed: boolean; + before(content: string, options?: ContentOptions): Comment; + after(content: string, options?: ContentOptions): Comment; + replace(content: string, options?: ContentOptions): Comment; + remove(): Comment; +} +interface Text { + readonly text: string; + readonly lastInTextNode: boolean; + readonly removed: boolean; + before(content: string | ReadableStream | Response, options?: ContentOptions): Text; + after(content: string | ReadableStream | Response, options?: ContentOptions): Text; + replace(content: string | ReadableStream | Response, options?: ContentOptions): Text; + remove(): Text; +} +interface DocumentEnd { + append(content: string, options?: ContentOptions): DocumentEnd; +} +/** + * This is the event type for `fetch` events dispatched on the ServiceWorkerGlobalScope. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent) + */ +declare abstract class FetchEvent extends ExtendableEvent { + /** + * The **`request`** read-only property of the the event handler. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/request) + */ + readonly request: Request; + /** + * The **`respondWith()`** method of allows you to provide a promise for a Response yourself. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/respondWith) + */ + respondWith(promise: Response | Promise): void; + passThroughOnException(): void; +} +type HeadersInit = Headers | Iterable> | Record; +/** + * The **`Headers`** interface of the Fetch API allows you to perform various actions on HTTP request and response headers. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers) + */ +declare class Headers { + constructor(init?: HeadersInit); + /** + * The **`get()`** method of the Headers interface returns a byte string of all the values of a header within a `Headers` object with a given name. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/get) + */ + get(name: string): string | null; + getAll(name: string): string[]; + /** + * The **`getSetCookie()`** method of the Headers interface returns an array containing the values of all Set-Cookie headers associated with a response. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/getSetCookie) + */ + getSetCookie(): string[]; + /** + * The **`has()`** method of the Headers interface returns a boolean stating whether a `Headers` object contains a certain header. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/has) + */ + has(name: string): boolean; + /** + * The **`set()`** method of the Headers interface sets a new value for an existing header inside a `Headers` object, or adds the header if it does not already exist. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/set) + */ + set(name: string, value: string): void; + /** + * The **`append()`** method of the Headers interface appends a new value onto an existing header inside a `Headers` object, or adds the header if it does not already exist. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/append) + */ + append(name: string, value: string): void; + /** + * The **`delete()`** method of the Headers interface deletes a header from the current `Headers` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/delete) + */ + delete(name: string): void; + forEach(callback: (this: This, value: string, key: string, parent: Headers) => void, thisArg?: This): void; + /* Returns an iterator allowing to go through all key/value pairs contained in this object. */ + entries(): IterableIterator<[ + key: string, + value: string + ]>; + /* Returns an iterator allowing to go through all keys of the key/value pairs contained in this object. */ + keys(): IterableIterator; + /* Returns an iterator allowing to go through all values of the key/value pairs contained in this object. */ + values(): IterableIterator; + [Symbol.iterator](): IterableIterator<[ + key: string, + value: string + ]>; +} +type BodyInit = ReadableStream | string | ArrayBuffer | ArrayBufferView | Blob | URLSearchParams | FormData | Iterable | AsyncIterable; +declare abstract class Body { + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body) */ + get body(): ReadableStream | null; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */ + get bodyUsed(): boolean; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */ + arrayBuffer(): Promise; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes) */ + bytes(): Promise; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/text) */ + text(): Promise; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/json) */ + json(): Promise; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/formData) */ + formData(): Promise; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */ + blob(): Promise; +} +/** + * The **`Response`** interface of the Fetch API represents the response to a request. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response) + */ +declare var Response: { + prototype: Response; + new (body?: BodyInit | null, init?: ResponseInit): Response; + error(): Response; + redirect(url: string, status?: number): Response; + json(any: any, maybeInit?: (ResponseInit | Response)): Response; +}; +/** + * The **`Response`** interface of the Fetch API represents the response to a request. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response) + */ +interface Response extends Body { + /** + * The **`clone()`** method of the Response interface creates a clone of a response object, identical in every way, but stored in a different variable. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/clone) + */ + clone(): Response; + /** + * The **`status`** read-only property of the Response interface contains the HTTP status codes of the response. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/status) + */ + status: number; + /** + * The **`statusText`** read-only property of the Response interface contains the status message corresponding to the HTTP status code in Response.status. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/statusText) + */ + statusText: string; + /** + * The **`headers`** read-only property of the with the response. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/headers) + */ + headers: Headers; + /** + * The **`ok`** read-only property of the Response interface contains a Boolean stating whether the response was successful (status in the range 200-299) or not. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/ok) + */ + ok: boolean; + /** + * The **`redirected`** read-only property of the Response interface indicates whether or not the response is the result of a request you made which was redirected. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirected) + */ + redirected: boolean; + /** + * The **`url`** read-only property of the Response interface contains the URL of the response. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/url) + */ + url: string; + webSocket: WebSocket | null; + cf: any | undefined; + /** + * The **`type`** read-only property of the Response interface contains the type of the response. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/type) + */ + type: "default" | "error"; +} +interface ResponseInit { + status?: number; + statusText?: string; + headers?: HeadersInit; + cf?: any; + webSocket?: (WebSocket | null); + encodeBody?: "automatic" | "manual"; +} +type RequestInfo> = Request | string; +/** + * The **`Request`** interface of the Fetch API represents a resource request. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request) + */ +declare var Request: { + prototype: Request; + new >(input: RequestInfo | URL, init?: RequestInit): Request; +}; +/** + * The **`Request`** interface of the Fetch API represents a resource request. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request) + */ +interface Request> extends Body { + /** + * The **`clone()`** method of the Request interface creates a copy of the current `Request` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/clone) + */ + clone(): Request; + /** + * The **`method`** read-only property of the `POST`, etc.) A String indicating the method of the request. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/method) + */ + method: string; + /** + * The **`url`** read-only property of the Request interface contains the URL of the request. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/url) + */ + url: string; + /** + * The **`headers`** read-only property of the with the request. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/headers) + */ + headers: Headers; + /** + * The **`redirect`** read-only property of the Request interface contains the mode for how redirects are handled. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/redirect) + */ + redirect: string; + fetcher: Fetcher | null; + /** + * The read-only **`signal`** property of the Request interface returns the AbortSignal associated with the request. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/signal) + */ + signal: AbortSignal; + cf?: Cf; + /** + * The **`integrity`** read-only property of the Request interface contains the subresource integrity value of the request. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/integrity) + */ + integrity: string; + /** + * The **`keepalive`** read-only property of the Request interface contains the request's `keepalive` setting (`true` or `false`), which indicates whether the browser will keep the associated request alive if the page that initiated it is unloaded before the request is complete. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/keepalive) + */ + keepalive: boolean; + /** + * The **`cache`** read-only property of the Request interface contains the cache mode of the request. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/cache) + */ + cache?: "no-store" | "no-cache"; +} +interface RequestInit { + /* A string to set request's method. */ + method?: string; + /* A Headers object, an object literal, or an array of two-item arrays to set request's headers. */ + headers?: HeadersInit; + /* A BodyInit object or null to set request's body. */ + body?: BodyInit | null; + /* A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect. */ + redirect?: string; + fetcher?: (Fetcher | null); + cf?: Cf; + /* A string indicating how the request will interact with the browser's cache to set request's cache. */ + cache?: "no-store" | "no-cache"; + /* A cryptographic hash of the resource to be fetched by request. Sets request's integrity. */ + integrity?: string; + /* An AbortSignal to set request's signal. */ + signal?: (AbortSignal | null); + encodeResponseBody?: "automatic" | "manual"; +} +type Service Rpc.WorkerEntrypointBranded) | Rpc.WorkerEntrypointBranded | ExportedHandler | undefined = undefined> = T extends new (...args: any[]) => Rpc.WorkerEntrypointBranded ? Fetcher> : T extends Rpc.WorkerEntrypointBranded ? Fetcher : T extends Exclude ? never : Fetcher; +type Fetcher = (T extends Rpc.EntrypointBranded ? Rpc.Provider : unknown) & { + fetch(input: RequestInfo | URL, init?: RequestInit): Promise; + connect(address: SocketAddress | string, options?: SocketOptions): Socket; +}; +interface KVNamespaceListKey { + name: Key; + expiration?: number; + metadata?: Metadata; +} +type KVNamespaceListResult = { + list_complete: false; + keys: KVNamespaceListKey[]; + cursor: string; + cacheStatus: string | null; +} | { + list_complete: true; + keys: KVNamespaceListKey[]; + cacheStatus: string | null; +}; +interface KVNamespace { + get(key: Key, options?: Partial>): Promise; + get(key: Key, type: "text"): Promise; + get(key: Key, type: "json"): Promise; + get(key: Key, type: "arrayBuffer"): Promise; + get(key: Key, type: "stream"): Promise; + get(key: Key, options?: KVNamespaceGetOptions<"text">): Promise; + get(key: Key, options?: KVNamespaceGetOptions<"json">): Promise; + get(key: Key, options?: KVNamespaceGetOptions<"arrayBuffer">): Promise; + get(key: Key, options?: KVNamespaceGetOptions<"stream">): Promise; + get(key: Array, type: "text"): Promise>; + get(key: Array, type: "json"): Promise>; + get(key: Array, options?: Partial>): Promise>; + get(key: Array, options?: KVNamespaceGetOptions<"text">): Promise>; + get(key: Array, options?: KVNamespaceGetOptions<"json">): Promise>; + list(options?: KVNamespaceListOptions): Promise>; + put(key: Key, value: string | ArrayBuffer | ArrayBufferView | ReadableStream, options?: KVNamespacePutOptions): Promise; + getWithMetadata(key: Key, options?: Partial>): Promise>; + getWithMetadata(key: Key, type: "text"): Promise>; + getWithMetadata(key: Key, type: "json"): Promise>; + getWithMetadata(key: Key, type: "arrayBuffer"): Promise>; + getWithMetadata(key: Key, type: "stream"): Promise>; + getWithMetadata(key: Key, options: KVNamespaceGetOptions<"text">): Promise>; + getWithMetadata(key: Key, options: KVNamespaceGetOptions<"json">): Promise>; + getWithMetadata(key: Key, options: KVNamespaceGetOptions<"arrayBuffer">): Promise>; + getWithMetadata(key: Key, options: KVNamespaceGetOptions<"stream">): Promise>; + getWithMetadata(key: Array, type: "text"): Promise>>; + getWithMetadata(key: Array, type: "json"): Promise>>; + getWithMetadata(key: Array, options?: Partial>): Promise>>; + getWithMetadata(key: Array, options?: KVNamespaceGetOptions<"text">): Promise>>; + getWithMetadata(key: Array, options?: KVNamespaceGetOptions<"json">): Promise>>; + delete(key: Key): Promise; +} +interface KVNamespaceListOptions { + limit?: number; + prefix?: (string | null); + cursor?: (string | null); +} +interface KVNamespaceGetOptions { + type: Type; + cacheTtl?: number; +} +interface KVNamespacePutOptions { + expiration?: number; + expirationTtl?: number; + metadata?: (any | null); +} +interface KVNamespaceGetWithMetadataResult { + value: Value | null; + metadata: Metadata | null; + cacheStatus: string | null; +} +type QueueContentType = "text" | "bytes" | "json" | "v8"; +interface Queue { + metrics(): Promise; + send(message: Body, options?: QueueSendOptions): Promise; + sendBatch(messages: Iterable>, options?: QueueSendBatchOptions): Promise; +} +interface QueueSendMetrics { + backlogCount: number; + backlogBytes: number; + oldestMessageTimestamp?: Date; +} +interface QueueSendMetadata { + metrics: QueueSendMetrics; +} +interface QueueSendResponse { + metadata: QueueSendMetadata; +} +interface QueueSendBatchMetrics { + backlogCount: number; + backlogBytes: number; + oldestMessageTimestamp?: Date; +} +interface QueueSendBatchMetadata { + metrics: QueueSendBatchMetrics; +} +interface QueueSendBatchResponse { + metadata: QueueSendBatchMetadata; +} +interface QueueSendOptions { + contentType?: QueueContentType; + delaySeconds?: number; +} +interface QueueSendBatchOptions { + delaySeconds?: number; +} +interface MessageSendRequest { + body: Body; + contentType?: QueueContentType; + delaySeconds?: number; +} +interface QueueMetrics { + backlogCount: number; + backlogBytes: number; + oldestMessageTimestamp?: Date; +} +interface MessageBatchMetrics { + backlogCount: number; + backlogBytes: number; + oldestMessageTimestamp?: Date; +} +interface MessageBatchMetadata { + metrics: MessageBatchMetrics; +} +interface QueueRetryOptions { + delaySeconds?: number; +} +interface Message { + readonly id: string; + readonly timestamp: Date; + readonly body: Body; + readonly attempts: number; + retry(options?: QueueRetryOptions): void; + ack(): void; +} +interface QueueEvent extends ExtendableEvent { + readonly messages: readonly Message[]; + readonly queue: string; + readonly metadata: MessageBatchMetadata; + retryAll(options?: QueueRetryOptions): void; + ackAll(): void; +} +interface MessageBatch { + readonly messages: readonly Message[]; + readonly queue: string; + readonly metadata: MessageBatchMetadata; + retryAll(options?: QueueRetryOptions): void; + ackAll(): void; +} +interface R2Error extends Error { + readonly name: string; + readonly code: number; + readonly message: string; + readonly action: string; + readonly stack: any; +} +interface R2ListOptions { + limit?: number; + prefix?: string; + cursor?: string; + delimiter?: string; + startAfter?: string; + include?: ("httpMetadata" | "customMetadata")[]; +} +interface R2Bucket { + head(key: string): Promise; + get(key: string, options: R2GetOptions & { + onlyIf: R2Conditional | Headers; + }): Promise; + get(key: string, options?: R2GetOptions): Promise; + put(key: string, value: ReadableStream | ArrayBuffer | ArrayBufferView | string | null | Blob, options?: R2PutOptions & { + onlyIf: R2Conditional | Headers; + }): Promise; + put(key: string, value: ReadableStream | ArrayBuffer | ArrayBufferView | string | null | Blob, options?: R2PutOptions): Promise; + createMultipartUpload(key: string, options?: R2MultipartOptions): Promise; + resumeMultipartUpload(key: string, uploadId: string): R2MultipartUpload; + delete(keys: string | string[]): Promise; + list(options?: R2ListOptions): Promise; +} +interface R2MultipartUpload { + readonly key: string; + readonly uploadId: string; + uploadPart(partNumber: number, value: ReadableStream | (ArrayBuffer | ArrayBufferView) | string | Blob, options?: R2UploadPartOptions): Promise; + abort(): Promise; + complete(uploadedParts: R2UploadedPart[]): Promise; +} +interface R2UploadedPart { + partNumber: number; + etag: string; +} +declare abstract class R2Object { + readonly key: string; + readonly version: string; + readonly size: number; + readonly etag: string; + readonly httpEtag: string; + readonly checksums: R2Checksums; + readonly uploaded: Date; + readonly httpMetadata?: R2HTTPMetadata; + readonly customMetadata?: Record; + readonly range?: R2Range; + readonly storageClass: string; + readonly ssecKeyMd5?: string; + writeHttpMetadata(headers: Headers): void; +} +interface R2ObjectBody extends R2Object { + get body(): ReadableStream; + get bodyUsed(): boolean; + arrayBuffer(): Promise; + bytes(): Promise; + text(): Promise; + json(): Promise; + blob(): Promise; +} +type R2Range = { + offset: number; + length?: number; +} | { + offset?: number; + length: number; +} | { + suffix: number; +}; +interface R2Conditional { + etagMatches?: string; + etagDoesNotMatch?: string; + uploadedBefore?: Date; + uploadedAfter?: Date; + secondsGranularity?: boolean; +} +interface R2GetOptions { + onlyIf?: (R2Conditional | Headers); + range?: (R2Range | Headers); + ssecKey?: (ArrayBuffer | string); +} +interface R2PutOptions { + onlyIf?: (R2Conditional | Headers); + httpMetadata?: (R2HTTPMetadata | Headers); + customMetadata?: Record; + md5?: ((ArrayBuffer | ArrayBufferView) | string); + sha1?: ((ArrayBuffer | ArrayBufferView) | string); + sha256?: ((ArrayBuffer | ArrayBufferView) | string); + sha384?: ((ArrayBuffer | ArrayBufferView) | string); + sha512?: ((ArrayBuffer | ArrayBufferView) | string); + storageClass?: string; + ssecKey?: (ArrayBuffer | string); +} +interface R2MultipartOptions { + httpMetadata?: (R2HTTPMetadata | Headers); + customMetadata?: Record; + storageClass?: string; + ssecKey?: (ArrayBuffer | string); +} +interface R2Checksums { + readonly md5?: ArrayBuffer; + readonly sha1?: ArrayBuffer; + readonly sha256?: ArrayBuffer; + readonly sha384?: ArrayBuffer; + readonly sha512?: ArrayBuffer; + toJSON(): R2StringChecksums; +} +interface R2StringChecksums { + md5?: string; + sha1?: string; + sha256?: string; + sha384?: string; + sha512?: string; +} +interface R2HTTPMetadata { + contentType?: string; + contentLanguage?: string; + contentDisposition?: string; + contentEncoding?: string; + cacheControl?: string; + cacheExpiry?: Date; +} +type R2Objects = { + objects: R2Object[]; + delimitedPrefixes: string[]; +} & ({ + truncated: true; + cursor: string; +} | { + truncated: false; +}); +interface R2UploadPartOptions { + ssecKey?: (ArrayBuffer | string); +} +declare abstract class ScheduledEvent extends ExtendableEvent { + readonly scheduledTime: number; + readonly cron: string; + noRetry(): void; +} +interface ScheduledController { + readonly scheduledTime: number; + readonly cron: string; + noRetry(): void; +} +interface QueuingStrategy { + highWaterMark?: (number | bigint); + size?: (chunk: T) => number | bigint; +} +interface UnderlyingSink { + type?: string; + start?: (controller: WritableStreamDefaultController) => void | Promise; + write?: (chunk: W, controller: WritableStreamDefaultController) => void | Promise; + abort?: (reason: any) => void | Promise; + close?: () => void | Promise; +} +interface UnderlyingByteSource { + type: "bytes"; + autoAllocateChunkSize?: number; + start?: (controller: ReadableByteStreamController) => void | Promise; + pull?: (controller: ReadableByteStreamController) => void | Promise; + cancel?: (reason: any) => void | Promise; +} +interface UnderlyingSource { + type?: "" | undefined; + start?: (controller: ReadableStreamDefaultController) => void | Promise; + pull?: (controller: ReadableStreamDefaultController) => void | Promise; + cancel?: (reason: any) => void | Promise; + expectedLength?: (number | bigint); +} +interface Transformer { + readableType?: string; + writableType?: string; + start?: (controller: TransformStreamDefaultController) => void | Promise; + transform?: (chunk: I, controller: TransformStreamDefaultController) => void | Promise; + flush?: (controller: TransformStreamDefaultController) => void | Promise; + cancel?: (reason: any) => void | Promise; + expectedLength?: number; +} +interface StreamPipeOptions { + preventAbort?: boolean; + preventCancel?: boolean; + /** + * Pipes this readable stream to a given writable stream destination. The way in which the piping process behaves under various error conditions can be customized with a number of passed options. It returns a promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered. + * + * Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader. + * + * Errors and closures of the source and destination streams propagate as follows: + * + * An error in this source readable stream will abort destination, unless preventAbort is truthy. The returned promise will be rejected with the source's error, or with any error that occurs during aborting the destination. + * + * An error in destination will cancel this source readable stream, unless preventCancel is truthy. The returned promise will be rejected with the destination's error, or with any error that occurs during canceling the source. + * + * When this source readable stream closes, destination will be closed, unless preventClose is truthy. The returned promise will be fulfilled once this process completes, unless an error is encountered while closing the destination, in which case it will be rejected with that error. + * + * If destination starts out closed or closing, this source readable stream will be canceled, unless preventCancel is true. The returned promise will be rejected with an error indicating piping to a closed stream failed, or with any error that occurs during canceling the source. + * + * The signal option can be set to an AbortSignal to allow aborting an ongoing pipe operation via the corresponding AbortController. In this case, this source readable stream will be canceled, and destination aborted, unless the respective options preventCancel or preventAbort are set. + */ + preventClose?: boolean; + signal?: AbortSignal; +} +type ReadableStreamReadResult = { + done: false; + value: R; +} | { + done: true; + value?: undefined; +}; +/** + * The `ReadableStream` interface of the Streams API represents a readable stream of byte data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream) + */ +interface ReadableStream { + /** + * The **`locked`** read-only property of the ReadableStream interface returns whether or not the readable stream is locked to a reader. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/locked) + */ + get locked(): boolean; + /** + * The **`cancel()`** method of the ReadableStream interface returns a Promise that resolves when the stream is canceled. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/cancel) + */ + cancel(reason?: any): Promise; + /** + * The **`getReader()`** method of the ReadableStream interface creates a reader and locks the stream to it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader) + */ + getReader(): ReadableStreamDefaultReader; + /** + * The **`getReader()`** method of the ReadableStream interface creates a reader and locks the stream to it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader) + */ + getReader(options: ReadableStreamGetReaderOptions): ReadableStreamBYOBReader; + /** + * The **`pipeThrough()`** method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeThrough) + */ + pipeThrough(transform: ReadableWritablePair, options?: StreamPipeOptions): ReadableStream; + /** + * The **`pipeTo()`** method of the ReadableStream interface pipes the current `ReadableStream` to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeTo) + */ + pipeTo(destination: WritableStream, options?: StreamPipeOptions): Promise; + /** + * The **`tee()`** method of the two-element array containing the two resulting branches as new ReadableStream instances. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee) + */ + tee(): [ + ReadableStream, + ReadableStream + ]; + values(options?: ReadableStreamValuesOptions): AsyncIterableIterator; + [Symbol.asyncIterator](options?: ReadableStreamValuesOptions): AsyncIterableIterator; +} +/** + * The `ReadableStream` interface of the Streams API represents a readable stream of byte data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream) + */ +declare const ReadableStream: { + prototype: ReadableStream; + new (underlyingSource: UnderlyingByteSource, strategy?: QueuingStrategy): ReadableStream; + new (underlyingSource?: UnderlyingSource, strategy?: QueuingStrategy): ReadableStream; +}; +/** + * The **`ReadableStreamDefaultReader`** interface of the Streams API represents a default reader that can be used to read stream data supplied from a network (such as a fetch request). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader) + */ +declare class ReadableStreamDefaultReader { + constructor(stream: ReadableStream); + get closed(): Promise; + cancel(reason?: any): Promise; + /** + * The **`read()`** method of the ReadableStreamDefaultReader interface returns a Promise providing access to the next chunk in the stream's internal queue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/read) + */ + read(): Promise>; + /** + * The **`releaseLock()`** method of the ReadableStreamDefaultReader interface releases the reader's lock on the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/releaseLock) + */ + releaseLock(): void; +} +/** + * The `ReadableStreamBYOBReader` interface of the Streams API defines a reader for a ReadableStream that supports zero-copy reading from an underlying byte source. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader) + */ +declare class ReadableStreamBYOBReader { + constructor(stream: ReadableStream); + get closed(): Promise; + cancel(reason?: any): Promise; + /** + * The **`read()`** method of the ReadableStreamBYOBReader interface is used to read data into a view on a user-supplied buffer from an associated readable byte stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read) + */ + read(view: T): Promise>; + /** + * The **`releaseLock()`** method of the ReadableStreamBYOBReader interface releases the reader's lock on the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock) + */ + releaseLock(): void; + readAtLeast(minElements: number, view: T): Promise>; +} +interface ReadableStreamBYOBReaderReadableStreamBYOBReaderReadOptions { + min?: number; +} +interface ReadableStreamGetReaderOptions { + /** + * Creates a ReadableStreamBYOBReader and locks the stream to the new reader. + * + * This call behaves the same way as the no-argument variant, except that it only works on readable byte streams, i.e. streams which were constructed specifically with the ability to handle "bring your own buffer" reading. The returned BYOB reader provides the ability to directly read individual chunks from the stream via its read() method, into developer-supplied buffers, allowing more precise control over allocation. + */ + mode: "byob"; +} +/** + * The **`ReadableStreamBYOBRequest`** interface of the Streams API represents a 'pull request' for data from an underlying source that will made as a zero-copy transfer to a consumer (bypassing the stream's internal queues). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest) + */ +declare abstract class ReadableStreamBYOBRequest { + /** + * The **`view`** getter property of the ReadableStreamBYOBRequest interface returns the current view. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/view) + */ + get view(): Uint8Array | null; + /** + * The **`respond()`** method of the ReadableStreamBYOBRequest interface is used to signal to the associated readable byte stream that the specified number of bytes were written into the ReadableStreamBYOBRequest.view. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respond) + */ + respond(bytesWritten: number): void; + /** + * The **`respondWithNewView()`** method of the ReadableStreamBYOBRequest interface specifies a new view that the consumer of the associated readable byte stream should write to instead of ReadableStreamBYOBRequest.view. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respondWithNewView) + */ + respondWithNewView(view: ArrayBuffer | ArrayBufferView): void; + get atLeast(): number | null; +} +/** + * The **`ReadableStreamDefaultController`** interface of the Streams API represents a controller allowing control of a ReadableStream's state and internal queue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController) + */ +declare abstract class ReadableStreamDefaultController { + /** + * The **`desiredSize`** read-only property of the required to fill the stream's internal queue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/desiredSize) + */ + get desiredSize(): number | null; + /** + * The **`close()`** method of the ReadableStreamDefaultController interface closes the associated stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/close) + */ + close(): void; + /** + * The **`enqueue()`** method of the ```js-nolint enqueue(chunk) ``` - `chunk` - : The chunk to enqueue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/enqueue) + */ + enqueue(chunk?: R): void; + /** + * The **`error()`** method of the with the associated stream to error. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/error) + */ + error(reason: any): void; +} +/** + * The **`ReadableByteStreamController`** interface of the Streams API represents a controller for a readable byte stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController) + */ +declare abstract class ReadableByteStreamController { + /** + * The **`byobRequest`** read-only property of the ReadableByteStreamController interface returns the current BYOB request, or `null` if there are no pending requests. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/byobRequest) + */ + get byobRequest(): ReadableStreamBYOBRequest | null; + /** + * The **`desiredSize`** read-only property of the ReadableByteStreamController interface returns the number of bytes required to fill the stream's internal queue to its 'desired size'. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/desiredSize) + */ + get desiredSize(): number | null; + /** + * The **`close()`** method of the ReadableByteStreamController interface closes the associated stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/close) + */ + close(): void; + /** + * The **`enqueue()`** method of the ReadableByteStreamController interface enqueues a given chunk on the associated readable byte stream (the chunk is copied into the stream's internal queues). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/enqueue) + */ + enqueue(chunk: ArrayBuffer | ArrayBufferView): void; + /** + * The **`error()`** method of the ReadableByteStreamController interface causes any future interactions with the associated stream to error with the specified reason. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/error) + */ + error(reason: any): void; +} +/** + * The **`WritableStreamDefaultController`** interface of the Streams API represents a controller allowing control of a WritableStream's state. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController) + */ +declare abstract class WritableStreamDefaultController { + /** + * The read-only **`signal`** property of the WritableStreamDefaultController interface returns the AbortSignal associated with the controller. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/signal) + */ + get signal(): AbortSignal; + /** + * The **`error()`** method of the with the associated stream to error. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/error) + */ + error(reason?: any): void; +} +/** + * The **`TransformStreamDefaultController`** interface of the Streams API provides methods to manipulate the associated ReadableStream and WritableStream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController) + */ +declare abstract class TransformStreamDefaultController { + /** + * The **`desiredSize`** read-only property of the TransformStreamDefaultController interface returns the desired size to fill the queue of the associated ReadableStream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/desiredSize) + */ + get desiredSize(): number | null; + /** + * The **`enqueue()`** method of the TransformStreamDefaultController interface enqueues the given chunk in the readable side of the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/enqueue) + */ + enqueue(chunk?: O): void; + /** + * The **`error()`** method of the TransformStreamDefaultController interface errors both sides of the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/error) + */ + error(reason: any): void; + /** + * The **`terminate()`** method of the TransformStreamDefaultController interface closes the readable side and errors the writable side of the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/terminate) + */ + terminate(): void; +} +interface ReadableWritablePair { + readable: ReadableStream; + /** + * Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other { writable, readable } pair). It simply pipes the stream into the writable side of the supplied pair, and returns the readable side for further use. + * + * Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader. + */ + writable: WritableStream; +} +/** + * The **`WritableStream`** interface of the Streams API provides a standard abstraction for writing streaming data to a destination, known as a sink. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream) + */ +declare class WritableStream { + constructor(underlyingSink?: UnderlyingSink, queuingStrategy?: QueuingStrategy); + /** + * The **`locked`** read-only property of the WritableStream interface returns a boolean indicating whether the `WritableStream` is locked to a writer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/locked) + */ + get locked(): boolean; + /** + * The **`abort()`** method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort) + */ + abort(reason?: any): Promise; + /** + * The **`close()`** method of the WritableStream interface closes the associated stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close) + */ + close(): Promise; + /** + * The **`getWriter()`** method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter) + */ + getWriter(): WritableStreamDefaultWriter; +} +/** + * The **`WritableStreamDefaultWriter`** interface of the Streams API is the object returned by WritableStream.getWriter() and once created locks the writer to the `WritableStream` ensuring that no other streams can write to the underlying sink. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter) + */ +declare class WritableStreamDefaultWriter { + constructor(stream: WritableStream); + /** + * The **`closed`** read-only property of the the stream errors or the writer's lock is released. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed) + */ + get closed(): Promise; + /** + * The **`ready`** read-only property of the that resolves when the desired size of the stream's internal queue transitions from non-positive to positive, signaling that it is no longer applying backpressure. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready) + */ + get ready(): Promise; + /** + * The **`desiredSize`** read-only property of the to fill the stream's internal queue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize) + */ + get desiredSize(): number | null; + /** + * The **`abort()`** method of the the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) + */ + abort(reason?: any): Promise; + /** + * The **`close()`** method of the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) + */ + close(): Promise; + /** + * The **`write()`** method of the operation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write) + */ + write(chunk?: W): Promise; + /** + * The **`releaseLock()`** method of the corresponding stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock) + */ + releaseLock(): void; +} +/** + * The **`TransformStream`** interface of the Streams API represents a concrete implementation of the pipe chain _transform stream_ concept. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream) + */ +declare class TransformStream { + constructor(transformer?: Transformer, writableStrategy?: QueuingStrategy, readableStrategy?: QueuingStrategy); + /** + * The **`readable`** read-only property of the TransformStream interface returns the ReadableStream instance controlled by this `TransformStream`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/readable) + */ + get readable(): ReadableStream; + /** + * The **`writable`** read-only property of the TransformStream interface returns the WritableStream instance controlled by this `TransformStream`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/writable) + */ + get writable(): WritableStream; +} +declare class FixedLengthStream extends IdentityTransformStream { + constructor(expectedLength: number | bigint, queuingStrategy?: IdentityTransformStreamQueuingStrategy); +} +declare class IdentityTransformStream extends TransformStream { + constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy); +} +interface IdentityTransformStreamQueuingStrategy { + highWaterMark?: (number | bigint); +} +interface ReadableStreamValuesOptions { + preventCancel?: boolean; +} +/** + * The **`CompressionStream`** interface of the Compression Streams API is an API for compressing a stream of data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CompressionStream) + */ +declare class CompressionStream extends TransformStream { + constructor(format: "gzip" | "deflate" | "deflate-raw"); +} +/** + * The **`DecompressionStream`** interface of the Compression Streams API is an API for decompressing a stream of data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DecompressionStream) + */ +declare class DecompressionStream extends TransformStream { + constructor(format: "gzip" | "deflate" | "deflate-raw"); +} +/** + * The **`TextEncoderStream`** interface of the Encoding API converts a stream of strings into bytes in the UTF-8 encoding. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoderStream) + */ +declare class TextEncoderStream extends TransformStream { + constructor(); + get encoding(): string; +} +/** + * The **`TextDecoderStream`** interface of the Encoding API converts a stream of text in a binary encoding, such as UTF-8 etc., to a stream of strings. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextDecoderStream) + */ +declare class TextDecoderStream extends TransformStream { + constructor(label?: string, options?: TextDecoderStreamTextDecoderStreamInit); + get encoding(): string; + get fatal(): boolean; + get ignoreBOM(): boolean; +} +interface TextDecoderStreamTextDecoderStreamInit { + fatal?: boolean; + ignoreBOM?: boolean; +} +/** + * The **`ByteLengthQueuingStrategy`** interface of the Streams API provides a built-in byte length queuing strategy that can be used when constructing streams. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy) + */ +declare class ByteLengthQueuingStrategy implements QueuingStrategy { + constructor(init: QueuingStrategyInit); + /** + * The read-only **`ByteLengthQueuingStrategy.highWaterMark`** property returns the total number of bytes that can be contained in the internal queue before backpressure is applied. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/highWaterMark) + */ + get highWaterMark(): number; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/size) */ + get size(): (chunk?: any) => number; +} +/** + * The **`CountQueuingStrategy`** interface of the Streams API provides a built-in chunk counting queuing strategy that can be used when constructing streams. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy) + */ +declare class CountQueuingStrategy implements QueuingStrategy { + constructor(init: QueuingStrategyInit); + /** + * The read-only **`CountQueuingStrategy.highWaterMark`** property returns the total number of chunks that can be contained in the internal queue before backpressure is applied. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/highWaterMark) + */ + get highWaterMark(): number; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/size) */ + get size(): (chunk?: any) => number; +} +interface QueuingStrategyInit { + /** + * Creates a new ByteLengthQueuingStrategy with the provided high water mark. + * + * Note that the provided high water mark will not be validated ahead of time. Instead, if it is negative, NaN, or not a number, the resulting ByteLengthQueuingStrategy will cause the corresponding stream constructor to throw. + */ + highWaterMark: number; +} +interface TracePreviewInfo { + id: string; + slug: string; + name: string; +} +interface ScriptVersion { + id?: string; + tag?: string; + message?: string; +} +declare abstract class TailEvent extends ExtendableEvent { + readonly events: TraceItem[]; + readonly traces: TraceItem[]; +} +interface TraceItem { + readonly event: (TraceItemFetchEventInfo | TraceItemJsRpcEventInfo | TraceItemConnectEventInfo | TraceItemScheduledEventInfo | TraceItemAlarmEventInfo | TraceItemQueueEventInfo | TraceItemEmailEventInfo | TraceItemTailEventInfo | TraceItemCustomEventInfo | TraceItemHibernatableWebSocketEventInfo) | null; + readonly eventTimestamp: number | null; + readonly logs: TraceLog[]; + readonly exceptions: TraceException[]; + readonly diagnosticsChannelEvents: TraceDiagnosticChannelEvent[]; + readonly scriptName: string | null; + readonly entrypoint?: string; + readonly scriptVersion?: ScriptVersion; + readonly dispatchNamespace?: string; + readonly scriptTags?: string[]; + readonly tailAttributes?: Record; + readonly preview?: TracePreviewInfo; + readonly durableObjectId?: string; + readonly outcome: string; + readonly executionModel: string; + readonly truncated: boolean; + readonly cpuTime: number; + readonly wallTime: number; +} +interface TraceItemAlarmEventInfo { + readonly scheduledTime: Date; +} +interface TraceItemConnectEventInfo { +} +interface TraceItemCustomEventInfo { +} +interface TraceItemScheduledEventInfo { + readonly scheduledTime: number; + readonly cron: string; +} +interface TraceItemQueueEventInfo { + readonly queue: string; + readonly batchSize: number; +} +interface TraceItemEmailEventInfo { + readonly mailFrom: string; + readonly rcptTo: string; + readonly rawSize: number; +} +interface TraceItemTailEventInfo { + readonly consumedEvents: TraceItemTailEventInfoTailItem[]; +} +interface TraceItemTailEventInfoTailItem { + readonly scriptName: string | null; +} +interface TraceItemFetchEventInfo { + readonly response?: TraceItemFetchEventInfoResponse; + readonly request: TraceItemFetchEventInfoRequest; +} +interface TraceItemFetchEventInfoRequest { + readonly cf?: any; + readonly headers: Record; + readonly method: string; + readonly url: string; + getUnredacted(): TraceItemFetchEventInfoRequest; +} +interface TraceItemFetchEventInfoResponse { + readonly status: number; +} +interface TraceItemJsRpcEventInfo { + readonly rpcMethod: string; +} +interface TraceItemHibernatableWebSocketEventInfo { + readonly getWebSocketEvent: TraceItemHibernatableWebSocketEventInfoMessage | TraceItemHibernatableWebSocketEventInfoClose | TraceItemHibernatableWebSocketEventInfoError; +} +interface TraceItemHibernatableWebSocketEventInfoMessage { + readonly webSocketEventType: string; +} +interface TraceItemHibernatableWebSocketEventInfoClose { + readonly webSocketEventType: string; + readonly code: number; + readonly wasClean: boolean; +} +interface TraceItemHibernatableWebSocketEventInfoError { + readonly webSocketEventType: string; +} +interface TraceLog { + readonly timestamp: number; + readonly level: string; + readonly message: any; +} +interface TraceException { + readonly timestamp: number; + readonly message: string; + readonly name: string; + readonly stack?: string; +} +interface TraceDiagnosticChannelEvent { + readonly timestamp: number; + readonly channel: string; + readonly message: any; +} +interface TraceMetrics { + readonly cpuTime: number; + readonly wallTime: number; +} +interface UnsafeTraceMetrics { + fromTrace(item: TraceItem): TraceMetrics; +} +/** + * The **`URL`** interface is used to parse, construct, normalize, and encode URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL) + */ +declare class URL { + constructor(url: string | URL, base?: string | URL); + /** + * The **`origin`** read-only property of the URL interface returns a string containing the Unicode serialization of the origin of the represented URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/origin) + */ + get origin(): string; + /** + * The **`href`** property of the URL interface is a string containing the whole URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/href) + */ + get href(): string; + /** + * The **`href`** property of the URL interface is a string containing the whole URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/href) + */ + set href(value: string); + /** + * The **`protocol`** property of the URL interface is a string containing the protocol or scheme of the URL, including the final `':'`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/protocol) + */ + get protocol(): string; + /** + * The **`protocol`** property of the URL interface is a string containing the protocol or scheme of the URL, including the final `':'`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/protocol) + */ + set protocol(value: string); + /** + * The **`username`** property of the URL interface is a string containing the username component of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/username) + */ + get username(): string; + /** + * The **`username`** property of the URL interface is a string containing the username component of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/username) + */ + set username(value: string); + /** + * The **`password`** property of the URL interface is a string containing the password component of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/password) + */ + get password(): string; + /** + * The **`password`** property of the URL interface is a string containing the password component of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/password) + */ + set password(value: string); + /** + * The **`host`** property of the URL interface is a string containing the host, which is the URL.hostname, and then, if the port of the URL is nonempty, a `':'`, followed by the URL.port of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/host) + */ + get host(): string; + /** + * The **`host`** property of the URL interface is a string containing the host, which is the URL.hostname, and then, if the port of the URL is nonempty, a `':'`, followed by the URL.port of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/host) + */ + set host(value: string); + /** + * The **`hostname`** property of the URL interface is a string containing either the domain name or IP address of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hostname) + */ + get hostname(): string; + /** + * The **`hostname`** property of the URL interface is a string containing either the domain name or IP address of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hostname) + */ + set hostname(value: string); + /** + * The **`port`** property of the URL interface is a string containing the port number of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/port) + */ + get port(): string; + /** + * The **`port`** property of the URL interface is a string containing the port number of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/port) + */ + set port(value: string); + /** + * The **`pathname`** property of the URL interface represents a location in a hierarchical structure. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/pathname) + */ + get pathname(): string; + /** + * The **`pathname`** property of the URL interface represents a location in a hierarchical structure. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/pathname) + */ + set pathname(value: string); + /** + * The **`search`** property of the URL interface is a search string, also called a _query string_, that is a string containing a `'?'` followed by the parameters of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/search) + */ + get search(): string; + /** + * The **`search`** property of the URL interface is a search string, also called a _query string_, that is a string containing a `'?'` followed by the parameters of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/search) + */ + set search(value: string); + /** + * The **`hash`** property of the URL interface is a string containing a `'#'` followed by the fragment identifier of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hash) + */ + get hash(): string; + /** + * The **`hash`** property of the URL interface is a string containing a `'#'` followed by the fragment identifier of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hash) + */ + set hash(value: string); + /** + * The **`searchParams`** read-only property of the access to the [MISSING: httpmethod('GET')] decoded query arguments contained in the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/searchParams) + */ + get searchParams(): URLSearchParams; + /** + * The **`toJSON()`** method of the URL interface returns a string containing a serialized version of the URL, although in practice it seems to have the same effect as ```js-nolint toJSON() ``` None. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/toJSON) + */ + toJSON(): string; + /*function toString() { [native code] }*/ + toString(): string; + /** + * The **`URL.canParse()`** static method of the URL interface returns a boolean indicating whether or not an absolute URL, or a relative URL combined with a base URL, are parsable and valid. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/canParse_static) + */ + static canParse(url: string, base?: string): boolean; + /** + * The **`URL.parse()`** static method of the URL interface returns a newly created URL object representing the URL defined by the parameters. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/parse_static) + */ + static parse(url: string, base?: string): URL | null; + /** + * The **`createObjectURL()`** static method of the URL interface creates a string containing a URL representing the object given in the parameter. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/createObjectURL_static) + */ + static createObjectURL(object: File | Blob): string; + /** + * The **`revokeObjectURL()`** static method of the URL interface releases an existing object URL which was previously created by calling Call this method when you've finished using an object URL to let the browser know not to keep the reference to the file any longer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/revokeObjectURL_static) + */ + static revokeObjectURL(object_url: string): void; +} +/** + * The **`URLSearchParams`** interface defines utility methods to work with the query string of a URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams) + */ +declare class URLSearchParams { + constructor(init?: (Iterable> | Record | string)); + /** + * The **`size`** read-only property of the URLSearchParams interface indicates the total number of search parameter entries. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/size) + */ + get size(): number; + /** + * The **`append()`** method of the URLSearchParams interface appends a specified key/value pair as a new search parameter. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/append) + */ + append(name: string, value: string): void; + /** + * The **`delete()`** method of the URLSearchParams interface deletes specified parameters and their associated value(s) from the list of all search parameters. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/delete) + */ + delete(name: string, value?: string): void; + /** + * The **`get()`** method of the URLSearchParams interface returns the first value associated to the given search parameter. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/get) + */ + get(name: string): string | null; + /** + * The **`getAll()`** method of the URLSearchParams interface returns all the values associated with a given search parameter as an array. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/getAll) + */ + getAll(name: string): string[]; + /** + * The **`has()`** method of the URLSearchParams interface returns a boolean value that indicates whether the specified parameter is in the search parameters. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/has) + */ + has(name: string, value?: string): boolean; + /** + * The **`set()`** method of the URLSearchParams interface sets the value associated with a given search parameter to the given value. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/set) + */ + set(name: string, value: string): void; + /** + * The **`URLSearchParams.sort()`** method sorts all key/value pairs contained in this object in place and returns `undefined`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/sort) + */ + sort(): void; + /* Returns an array of key, value pairs for every entry in the search params. */ + entries(): IterableIterator<[ + key: string, + value: string + ]>; + /* Returns a list of keys in the search params. */ + keys(): IterableIterator; + /* Returns a list of values in the search params. */ + values(): IterableIterator; + forEach(callback: (this: This, value: string, key: string, parent: URLSearchParams) => void, thisArg?: This): void; + /*function toString() { [native code] }*/ + toString(): string; + [Symbol.iterator](): IterableIterator<[ + key: string, + value: string + ]>; +} +declare class URLPattern { + constructor(input?: (string | URLPatternInit), baseURL?: (string | URLPatternOptions), patternOptions?: URLPatternOptions); + get protocol(): string; + get username(): string; + get password(): string; + get hostname(): string; + get port(): string; + get pathname(): string; + get search(): string; + get hash(): string; + get hasRegExpGroups(): boolean; + test(input?: (string | URLPatternInit), baseURL?: string): boolean; + exec(input?: (string | URLPatternInit), baseURL?: string): URLPatternResult | null; +} +interface URLPatternInit { + protocol?: string; + username?: string; + password?: string; + hostname?: string; + port?: string; + pathname?: string; + search?: string; + hash?: string; + baseURL?: string; +} +interface URLPatternComponentResult { + input: string; + groups: Record; +} +interface URLPatternResult { + inputs: (string | URLPatternInit)[]; + protocol: URLPatternComponentResult; + username: URLPatternComponentResult; + password: URLPatternComponentResult; + hostname: URLPatternComponentResult; + port: URLPatternComponentResult; + pathname: URLPatternComponentResult; + search: URLPatternComponentResult; + hash: URLPatternComponentResult; +} +interface URLPatternOptions { + ignoreCase?: boolean; +} +/** + * A `CloseEvent` is sent to clients using WebSockets when the connection is closed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent) + */ +declare class CloseEvent extends Event { + constructor(type: string, initializer?: CloseEventInit); + /** + * The **`code`** read-only property of the CloseEvent interface returns a WebSocket connection close code indicating the reason the connection was closed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/code) + */ + readonly code: number; + /** + * The **`reason`** read-only property of the CloseEvent interface returns the WebSocket connection close reason the server gave for closing the connection; that is, a concise human-readable prose explanation for the closure. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/reason) + */ + readonly reason: string; + /** + * The **`wasClean`** read-only property of the CloseEvent interface returns `true` if the connection closed cleanly. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/wasClean) + */ + readonly wasClean: boolean; +} +interface CloseEventInit { + code?: number; + reason?: string; + wasClean?: boolean; +} +type WebSocketEventMap = { + close: CloseEvent; + message: MessageEvent; + open: Event; + error: ErrorEvent; +}; +/** + * The `WebSocket` object provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket) + */ +declare var WebSocket: { + prototype: WebSocket; + new (url: string, protocols?: (string[] | string)): WebSocket; + readonly READY_STATE_CONNECTING: number; + readonly CONNECTING: number; + readonly READY_STATE_OPEN: number; + readonly OPEN: number; + readonly READY_STATE_CLOSING: number; + readonly CLOSING: number; + readonly READY_STATE_CLOSED: number; + readonly CLOSED: number; +}; +/** + * The `WebSocket` object provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket) + */ +interface WebSocket extends EventTarget { + accept(options?: WebSocketAcceptOptions): void; + /** + * The **`WebSocket.send()`** method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of `bufferedAmount` by the number of bytes needed to contain the data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/send) + */ + send(message: (ArrayBuffer | ArrayBufferView) | string): void; + /** + * The **`WebSocket.close()`** method closes the already `CLOSED`, this method does nothing. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/close) + */ + close(code?: number, reason?: string): void; + serializeAttachment(attachment: any): void; + deserializeAttachment(): any | null; + /** + * The **`WebSocket.readyState`** read-only property returns the current state of the WebSocket connection. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/readyState) + */ + readyState: number; + /** + * The **`WebSocket.url`** read-only property returns the absolute URL of the WebSocket as resolved by the constructor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/url) + */ + url: string | null; + /** + * The **`WebSocket.protocol`** read-only property returns the name of the sub-protocol the server selected; this will be one of the strings specified in the `protocols` parameter when creating the WebSocket object, or the empty string if no connection is established. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/protocol) + */ + protocol: string | null; + /** + * The **`WebSocket.extensions`** read-only property returns the extensions selected by the server. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/extensions) + */ + extensions: string | null; + /** + * The **`WebSocket.binaryType`** property controls the type of binary data being received over the WebSocket connection. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/binaryType) + */ + binaryType: "blob" | "arraybuffer"; +} +interface WebSocketAcceptOptions { + /** + * When set to `true`, receiving a server-initiated WebSocket Close frame will not + * automatically send a reciprocal Close frame, leaving the connection in a half-open + * state. This is useful for proxying scenarios where you need to coordinate closing + * both sides independently. Defaults to `false` when the + * `no_web_socket_half_open_by_default` compatibility flag is enabled. + */ + allowHalfOpen?: boolean; +} +declare const WebSocketPair: { + new (): { + 0: WebSocket; + 1: WebSocket; + }; +}; +interface SqlStorage { + exec>(query: string, ...bindings: any[]): SqlStorageCursor; + get databaseSize(): number; + Cursor: typeof SqlStorageCursor; + Statement: typeof SqlStorageStatement; +} +declare abstract class SqlStorageStatement { +} +type SqlStorageValue = ArrayBuffer | string | number | null; +declare abstract class SqlStorageCursor> { + next(): { + done?: false; + value: T; + } | { + done: true; + value?: never; + }; + toArray(): T[]; + one(): T; + raw(): IterableIterator; + columnNames: string[]; + get rowsRead(): number; + get rowsWritten(): number; + [Symbol.iterator](): IterableIterator; +} +interface Socket { + get readable(): ReadableStream; + get writable(): WritableStream; + get closed(): Promise; + get opened(): Promise; + get upgraded(): boolean; + get secureTransport(): "on" | "off" | "starttls"; + close(): Promise; + startTls(options?: TlsOptions): Socket; +} +interface SocketOptions { + secureTransport?: string; + allowHalfOpen: boolean; + highWaterMark?: (number | bigint); +} +interface SocketAddress { + hostname: string; + port: number; +} +interface TlsOptions { + expectedServerHostname?: string; +} +interface SocketInfo { + remoteAddress?: string; + localAddress?: string; +} +/** + * The **`EventSource`** interface is web content's interface to server-sent events. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource) + */ +declare class EventSource extends EventTarget { + constructor(url: string, init?: EventSourceEventSourceInit); + /** + * The **`close()`** method of the EventSource interface closes the connection, if one is made, and sets the ```js-nolint close() ``` None. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/close) + */ + close(): void; + /** + * The **`url`** read-only property of the URL of the source. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/url) + */ + get url(): string; + /** + * The **`withCredentials`** read-only property of the the `EventSource` object was instantiated with CORS credentials set. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/withCredentials) + */ + get withCredentials(): boolean; + /** + * The **`readyState`** read-only property of the connection. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/readyState) + */ + get readyState(): number; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/open_event) */ + get onopen(): any | null; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/open_event) */ + set onopen(value: any | null); + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/message_event) */ + get onmessage(): any | null; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/message_event) */ + set onmessage(value: any | null); + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/error_event) */ + get onerror(): any | null; + /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/error_event) */ + set onerror(value: any | null); + static readonly CONNECTING: number; + static readonly OPEN: number; + static readonly CLOSED: number; + static from(stream: ReadableStream): EventSource; +} +interface EventSourceEventSourceInit { + withCredentials?: boolean; + fetcher?: Fetcher; +} +interface Container { + get running(): boolean; + start(options?: ContainerStartupOptions): void; + monitor(): Promise; + destroy(error?: any): Promise; + signal(signo: number): void; + getTcpPort(port: number): Fetcher; + setInactivityTimeout(durationMs: number | bigint): Promise; + interceptOutboundHttp(addr: string, binding: Fetcher): Promise; + interceptAllOutboundHttp(binding: Fetcher): Promise; + snapshotDirectory(options: ContainerDirectorySnapshotOptions): Promise; + snapshotContainer(options: ContainerSnapshotOptions): Promise; + interceptOutboundHttps(addr: string, binding: Fetcher): Promise; +} +interface ContainerDirectorySnapshot { + id: string; + size: number; + dir: string; + name?: string; +} +interface ContainerDirectorySnapshotOptions { + dir: string; + name?: string; +} +interface ContainerDirectorySnapshotRestoreParams { + snapshot: ContainerDirectorySnapshot; + mountPoint?: string; +} +interface ContainerSnapshot { + id: string; + size: number; + name?: string; +} +interface ContainerSnapshotOptions { + name?: string; +} +interface ContainerStartupOptions { + entrypoint?: string[]; + enableInternet: boolean; + env?: Record; + labels?: Record; + directorySnapshots?: ContainerDirectorySnapshotRestoreParams[]; + containerSnapshot?: ContainerSnapshot; +} +/** + * The **`MessagePort`** interface of the Channel Messaging API represents one of the two ports of a MessageChannel, allowing messages to be sent from one port and listening out for them arriving at the other. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort) + */ +declare abstract class MessagePort extends EventTarget { + /** + * The **`postMessage()`** method of the transfers ownership of objects to other browsing contexts. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/postMessage) + */ + postMessage(data?: any, options?: (any[] | MessagePortPostMessageOptions)): void; + /** + * The **`close()`** method of the MessagePort interface disconnects the port, so it is no longer active. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/close) + */ + close(): void; + /** + * The **`start()`** method of the MessagePort interface starts the sending of messages queued on the port. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/start) + */ + start(): void; + get onmessage(): any | null; + set onmessage(value: any | null); +} +/** + * The **`MessageChannel`** interface of the Channel Messaging API allows us to create a new message channel and send data through it via its two MessagePort properties. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageChannel) + */ +declare class MessageChannel { + constructor(); + /** + * The **`port1`** read-only property of the the port attached to the context that originated the channel. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageChannel/port1) + */ + readonly port1: MessagePort; + /** + * The **`port2`** read-only property of the the port attached to the context at the other end of the channel, which the message is initially sent to. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageChannel/port2) + */ + readonly port2: MessagePort; +} +interface MessagePortPostMessageOptions { + transfer?: any[]; +} +type LoopbackForExport Rpc.EntrypointBranded) | ExportedHandler | undefined = undefined> = T extends new (...args: any[]) => Rpc.WorkerEntrypointBranded ? LoopbackServiceStub> : T extends new (...args: any[]) => Rpc.DurableObjectBranded ? LoopbackDurableObjectClass> : T extends ExportedHandler ? LoopbackServiceStub : undefined; +type LoopbackServiceStub = Fetcher & (T extends CloudflareWorkersModule.WorkerEntrypoint ? (opts: { + props?: Props; +}) => Fetcher : (opts: { + props?: any; +}) => Fetcher); +type LoopbackDurableObjectClass = DurableObjectClass & (T extends CloudflareWorkersModule.DurableObject ? (opts: { + props?: Props; +}) => DurableObjectClass : (opts: { + props?: any; +}) => DurableObjectClass); +interface LoopbackDurableObjectNamespace extends DurableObjectNamespace { +} +interface LoopbackColoLocalActorNamespace extends ColoLocalActorNamespace { +} +interface SyncKvStorage { + get(key: string): T | undefined; + list(options?: SyncKvListOptions): Iterable<[ + string, + T + ]>; + put(key: string, value: T): void; + delete(key: string): boolean; +} +interface SyncKvListOptions { + start?: string; + startAfter?: string; + end?: string; + prefix?: string; + reverse?: boolean; + limit?: number; +} +interface WorkerStub { + getEntrypoint(name?: string, options?: WorkerStubEntrypointOptions): Fetcher; + getDurableObjectClass(name?: string, options?: WorkerStubEntrypointOptions): DurableObjectClass; +} +interface WorkerStubEntrypointOptions { + props?: any; + limits?: workerdResourceLimits; +} +interface WorkerLoader { + get(name: string | null, getCode: () => WorkerLoaderWorkerCode | Promise): WorkerStub; + load(code: WorkerLoaderWorkerCode): WorkerStub; +} +interface WorkerLoaderModule { + js?: string; + cjs?: string; + text?: string; + data?: ArrayBuffer; + json?: any; + py?: string; + wasm?: ArrayBuffer; +} +interface WorkerLoaderWorkerCode { + compatibilityDate: string; + compatibilityFlags?: string[]; + allowExperimental?: boolean; + limits?: workerdResourceLimits; + mainModule: string; + modules: Record; + env?: any; + globalOutbound?: (Fetcher | null); + tails?: Fetcher[]; + streamingTails?: Fetcher[]; +} +interface workerdResourceLimits { + cpuMs?: number; + subRequests?: number; +} +/** +* The Workers runtime supports a subset of the Performance API, used to measure timing and performance, +* as well as timing of subrequests and other operations. +* +* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/) +*/ +declare abstract class Performance { + /* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/#performancetimeorigin) */ + get timeOrigin(): number; + /* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/#performancenow) */ + now(): number; + /** + * The **`toJSON()`** method of the Performance interface is a Serialization; it returns a JSON representation of the Performance object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Performance/toJSON) + */ + toJSON(): object; +} +interface Tracing { + enterSpan(name: string, callback: (span: Span, ...args: A) => T, ...args: A): T; + Span: typeof Span; +} +declare abstract class Span { + get isTraced(): boolean; + setAttribute(key: string, value?: (boolean | number | string)): void; +} +// ============ AI Search Error Interfaces ============ +interface AiSearchInternalError extends Error { +} +interface AiSearchNotFoundError extends Error { +} +// ============ AI Search Common Types ============ +/** A single message in a conversation-style search or chat request. */ +type AiSearchMessage = { + role: 'system' | 'developer' | 'user' | 'assistant' | 'tool'; + content: string | null; +}; +/** + * Common shape for `ai_search_options` used by both single-instance and multi-instance requests. + * Contains retrieval, query rewrite, reranking, and cache sub-options. + */ +type AiSearchOptions = { + retrieval?: { + /** Which retrieval backend to use. Defaults to the instance's configured index_method. */ + retrieval_type?: 'vector' | 'keyword' | 'hybrid'; + /** Fusion method for combining vector + keyword results. */ + fusion_method?: 'max' | 'rrf'; + /** How keyword terms are combined: "and" = all terms must match, "or" = any term matches. */ + keyword_match_mode?: 'and' | 'or'; + /** Minimum similarity score (0-1) for a result to be included. Default 0.4. */ + match_threshold?: number; + /** Maximum number of results to return (1-50). Default 10. */ + max_num_results?: number; + /** Vectorize metadata filters applied to the search. */ + filters?: VectorizeVectorMetadataFilter; + /** Number of surrounding chunks to include for context (0-3). Default 0. */ + context_expansion?: number; + /** If true, return only item metadata without chunk text. */ + metadata_only?: boolean; + /** If true (default), return empty results on retrieval failure instead of throwing. */ + return_on_failure?: boolean; + /** Boost results by metadata field values. Max 3 entries. */ + boost_by?: Array<{ + field: string; + direction?: 'asc' | 'desc' | 'exists' | 'not_exists'; + }>; + [key: string]: unknown; + }; + query_rewrite?: { + enabled?: boolean; + model?: string; + rewrite_prompt?: string; + [key: string]: unknown; + }; + reranking?: { + enabled?: boolean; + model?: string; + /** Match threshold (0-1, default 0.4) */ + match_threshold?: number; + [key: string]: unknown; + }; + cache?: { + enabled?: boolean; + cache_threshold?: 'super_strict_match' | 'close_enough' | 'flexible_friend' | 'anything_goes'; + }; + [key: string]: unknown; +}; +// ============ AI Search Request Types ============ +/** + * Request body for single-instance search. + * Exactly one of `query` or `messages` must be provided. + */ +type AiSearchSearchRequest = { + /** Simple query string. */ + query: string; + messages?: never; + ai_search_options?: AiSearchOptions; +} | { + query?: never; + /** Conversation-style input. At least one user message with non-empty content is required. */ + messages: AiSearchMessage[]; + ai_search_options?: AiSearchOptions; +}; +type AiSearchChatCompletionsRequest = { + messages: AiSearchMessage[]; + model?: string; + stream?: boolean; + ai_search_options?: AiSearchOptions; + [key: string]: unknown; +}; +// ============ AI Search Multi-Instance Types (Namespace-Scoped) ============ +/** `ai_search_options` shape for multi-instance requests — requires `instance_ids`. */ +type AiSearchMultiSearchOptions = AiSearchOptions & { + /** Instance IDs to search across (1-10). */ + instance_ids: string[]; +}; +/** + * Request for searching across multiple instances within a namespace. + * `ai_search_options` is required and must include `instance_ids`. + * Exactly one of `query` or `messages` must be provided. + */ +type AiSearchMultiSearchRequest = { + /** Simple query string. */ + query: string; + messages?: never; + ai_search_options: AiSearchMultiSearchOptions; +} | { + query?: never; + /** Conversation-style input. */ + messages: AiSearchMessage[]; + ai_search_options: AiSearchMultiSearchOptions; +}; +/** A search result chunk tagged with the instance it originated from. */ +type AiSearchMultiSearchChunk = AiSearchSearchResponse['chunks'][number] & { + instance_id: string; +}; +/** Describes a per-instance error during a multi-instance operation. */ +type AiSearchMultiSearchError = { + instance_id: string; + message: string; +}; +/** Response from a multi-instance search, with chunks tagged by instance and optional partial-failure errors. */ +type AiSearchMultiSearchResponse = { + search_query: string; + chunks: AiSearchMultiSearchChunk[]; + errors?: AiSearchMultiSearchError[]; +}; +/** Request for chat completions across multiple instances within a namespace. `ai_search_options` is required and must include `instance_ids`. */ +type AiSearchMultiChatCompletionsRequest = Omit & { + ai_search_options: AiSearchMultiSearchOptions; +}; +/** Response from multi-instance chat completions, with chunks tagged by instance and optional partial-failure errors. */ +type AiSearchMultiChatCompletionsResponse = Omit & { + chunks: AiSearchMultiSearchChunk[]; + errors?: AiSearchMultiSearchError[]; +}; +// ============ AI Search Response Types ============ +type AiSearchSearchResponse = { + search_query: string; + chunks: Array<{ + id: string; + type: string; + /** Match score (0-1) */ + score: number; + text: string; + item: { + timestamp?: number; + key: string; + metadata?: Record; + }; + scoring_details?: { + /** Keyword match score (0-1) */ + keyword_score?: number; + /** Vector similarity score (0-1) */ + vector_score?: number; + /** Keyword rank position */ + keyword_rank?: number; + /** Vector rank position */ + vector_rank?: number; + /** Reranking model score */ + reranking_score?: number; + /** Fusion method used to combine results */ + fusion_method?: 'rrf' | 'max'; + [key: string]: unknown; + }; + }>; +}; +type AiSearchChatCompletionsResponse = { + id?: string; + object?: string; + model?: string; + choices: Array<{ + index?: number; + message: { + role: 'system' | 'developer' | 'user' | 'assistant' | 'tool'; + content: string | null; + [key: string]: unknown; + }; + [key: string]: unknown; + }>; + chunks: AiSearchSearchResponse['chunks']; + [key: string]: unknown; +}; +type AiSearchStatsResponse = { + queued?: number; + running?: number; + completed?: number; + error?: number; + skipped?: number; + outdated?: number; + last_activity?: string; + /** Storage engine statistics. */ + engine?: { + vectorize?: { + vectorsCount: number; + dimensions: number; + }; + r2?: { + payloadSizeBytes: number; + metadataSizeBytes: number; + objectCount: number; + }; + }; +}; +// ============ AI Search Instance Info Types ============ +type AiSearchInstanceInfo = { + id: string; + type?: 'r2' | 'web-crawler' | string; + source?: string; + source_params?: unknown; + paused?: boolean; + status?: string; + namespace?: string; + created_at?: string; + modified_at?: string; + token_id?: string; + ai_gateway_id?: string; + rewrite_query?: boolean; + reranking?: boolean; + embedding_model?: string; + ai_search_model?: string; + rewrite_model?: string; + reranking_model?: string; + /** @deprecated Use index_method instead. */ + hybrid_search_enabled?: boolean; + /** Controls which storage backends are active. */ + index_method?: { + vector?: boolean; + keyword?: boolean; + }; + /** Fusion method for combining vector and keyword results. */ + fusion_method?: 'max' | 'rrf'; + indexing_options?: { + keyword_tokenizer?: 'porter' | 'trigram'; + } | null; + retrieval_options?: { + keyword_match_mode?: 'and' | 'or'; + boost_by?: Array<{ + field: string; + direction?: 'asc' | 'desc' | 'exists' | 'not_exists'; + }>; + } | null; + chunk?: boolean; + chunk_size?: number; + chunk_overlap?: number; + score_threshold?: number; + max_num_results?: number; + cache?: boolean; + cache_threshold?: 'super_strict_match' | 'close_enough' | 'flexible_friend' | 'anything_goes'; + custom_metadata?: Array<{ + field_name: string; + data_type: 'text' | 'number' | 'boolean' | 'datetime'; + }>; + /** Sync interval in seconds. */ + sync_interval?: 3600 | 7200 | 14400 | 21600 | 43200 | 86400; + metadata?: Record; + [key: string]: unknown; +}; +/** Pagination, search, and ordering parameters for listing instances within a namespace. */ +type AiSearchListInstancesParams = { + page?: number; + per_page?: number; + /** Search instances by ID. */ + search?: string; + /** Field to sort by. */ + order_by?: 'created_at'; + /** Sort direction. */ + order_by_direction?: 'asc' | 'desc'; +}; +type AiSearchListResponse = { + result: AiSearchInstanceInfo[]; + result_info?: { + count: number; + page: number; + per_page: number; + total_count: number; + }; +}; +// ============ AI Search Config Types ============ +type AiSearchConfig = { + /** Instance ID (1-32 chars, pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$) */ + id: string; + /** Instance type. Omit to create with built-in storage. */ + type?: 'r2' | 'web-crawler' | string; + /** Source URL (required for web-crawler type). */ + source?: string; + source_params?: unknown; + /** Token ID (UUID format) */ + token_id?: string; + ai_gateway_id?: string; + /** Enable query rewriting (default false) */ + rewrite_query?: boolean; + /** Enable reranking (default false) */ + reranking?: boolean; + embedding_model?: string; + ai_search_model?: string; + rewrite_model?: string; + reranking_model?: string; + /** @deprecated Use index_method instead. */ + hybrid_search_enabled?: boolean; + /** Controls which storage backends are used during indexing. Defaults to vector-only. */ + index_method?: { + vector?: boolean; + keyword?: boolean; + }; + /** Fusion method for combining vector and keyword results. "rrf" = reciprocal rank fusion (default), "max" = maximum score. */ + fusion_method?: 'max' | 'rrf'; + indexing_options?: { + keyword_tokenizer?: 'porter' | 'trigram'; + } | null; + retrieval_options?: { + keyword_match_mode?: 'and' | 'or'; + boost_by?: Array<{ + field: string; + direction?: 'asc' | 'desc' | 'exists' | 'not_exists'; + }>; + } | null; + chunk?: boolean; + chunk_size?: number; + chunk_overlap?: number; + /** Minimum similarity score (0-1) for a result to be included. */ + score_threshold?: number; + max_num_results?: number; + cache?: boolean; + /** Similarity threshold for cache hits. Stricter = fewer cache hits but higher relevance. */ + cache_threshold?: 'super_strict_match' | 'close_enough' | 'flexible_friend' | 'anything_goes'; + custom_metadata?: Array<{ + field_name: string; + data_type: 'text' | 'number' | 'boolean' | 'datetime'; + }>; + namespace?: string; + /** Sync interval in seconds. 3600=1h, 7200=2h, 14400=4h, 21600=6h, 43200=12h, 86400=24h. */ + sync_interval?: 3600 | 7200 | 14400 | 21600 | 43200 | 86400; + metadata?: Record; + [key: string]: unknown; +}; +// ============ AI Search Item Types ============ +type AiSearchItemInfo = { + id: string; + key: string; + status: 'completed' | 'error' | 'skipped' | 'queued' | 'running' | 'outdated'; + next_action?: 'INDEX' | 'DELETE' | null; + error?: string; + checksum?: string; + namespace?: string; + chunks_count?: number | null; + file_size?: number | null; + source_id?: string | null; + last_seen_at?: string; + created_at?: string; + metadata?: Record; + [key: string]: unknown; +}; +type AiSearchItemContentResult = { + body: ReadableStream; + contentType: string; + filename: string; + size: number; +}; +type AiSearchUploadItemOptions = { + metadata?: Record; +}; +type AiSearchListItemsParams = { + page?: number; + per_page?: number; + /** Search items by key name. */ + search?: string; + /** Sort order for results. */ + sort_by?: 'status' | 'modified_at'; + /** Filter items by processing status. */ + status?: 'queued' | 'running' | 'completed' | 'error' | 'skipped' | 'outdated'; + /** Filter items by source (e.g. "builtin" or "web-crawler:https://example.com"). */ + source?: string; + /** JSON-encoded Vectorize filter for metadata filtering. */ + metadata_filter?: string; +}; +type AiSearchListItemsResponse = { + result: AiSearchItemInfo[]; + result_info?: { + count: number; + page: number; + per_page: number; + total_count: number; + }; +}; +// ============ AI Search Item Logs Types ============ +type AiSearchItemLogsParams = { + /** Maximum number of log entries to return (1-100, default 50). */ + limit?: number; + /** Opaque cursor for pagination. Pass the `cursor` value from a previous response. */ + cursor?: string; +}; +type AiSearchItemLog = { + timestamp: string; + action: string; + message: string; + fileKey?: string; + chunkCount?: number; + processingTimeMs?: number; + errorType?: string; +}; +/** Paginated response for item processing logs (cursor-based). */ +type AiSearchItemLogsResponse = { + result: AiSearchItemLog[]; + result_info: { + count: number; + per_page: number; + cursor: string | null; + truncated: boolean; + }; +}; +// ============ AI Search Item Chunks Types ============ +type AiSearchItemChunksParams = { + /** Maximum number of chunks to return (1-100, default 20). */ + limit?: number; + /** Offset into the chunks list (default 0). */ + offset?: number; +}; +/** A single indexed chunk belonging to an item, including its text content and byte range. */ +type AiSearchItemChunk = { + id: string; + text: string; + start_byte: number; + end_byte: number; + item?: { + timestamp?: number; + key: string; + metadata?: Record; + }; +}; +/** Paginated response for item chunks (offset-based). */ +type AiSearchItemChunksResponse = { + result: AiSearchItemChunk[]; + result_info: { + count: number; + total: number; + limit: number; + offset: number; + }; +}; +// ============ AI Search Job Types ============ +type AiSearchJobInfo = { + id: string; + source: 'user' | 'schedule'; + description?: string; + last_seen_at?: string; + started_at?: string; + ended_at?: string; + end_reason?: string; +}; +type AiSearchJobLog = { + id: number; + message: string; + message_type: number; + created_at: number; +}; +type AiSearchCreateJobParams = { + description?: string; +}; +type AiSearchListJobsParams = { + page?: number; + per_page?: number; +}; +type AiSearchListJobsResponse = { + result: AiSearchJobInfo[]; + result_info?: { + count: number; + page: number; + per_page: number; + total_count: number; + }; +}; +type AiSearchJobLogsParams = { + page?: number; + per_page?: number; +}; +type AiSearchJobLogsResponse = { + result: AiSearchJobLog[]; + result_info?: { + count: number; + page: number; + per_page: number; + total_count: number; + }; +}; +// ============ AI Search Sub-Service Classes ============ +/** + * Single item service for an AI Search instance. + * Provides info, download, sync, logs, and chunks operations on a specific item. + */ +declare abstract class AiSearchItem { + /** Get metadata about this item. */ + info(): Promise; + /** + * Download the item's content. + * @returns Object with body stream, content type, filename, and size. + */ + download(): Promise; + /** + * Trigger re-indexing of this item. + * @returns The updated item info. + */ + sync(): Promise; + /** + * Retrieve processing logs for this item (cursor-based pagination). + * @param params Optional pagination parameters (limit, cursor). + * @returns Paginated log entries for this item. + */ + logs(params?: AiSearchItemLogsParams): Promise; + /** + * List indexed chunks for this item (offset-based pagination). + * @param params Optional pagination parameters (limit, offset). + * @returns Paginated chunk entries for this item. + */ + chunks(params?: AiSearchItemChunksParams): Promise; +} +/** + * Items collection service for an AI Search instance. + * Provides list, upload, and access to individual items. + */ +declare abstract class AiSearchItems { + /** List items in this instance. */ + list(params?: AiSearchListItemsParams): Promise; + /** + * Upload a file as an item. Behaves as an upsert: if an item with the same + * filename already exists, it is overwritten and re-indexed. + * @param name Filename for the uploaded item. + * @param content File content as a ReadableStream, Blob, or string. + * @param options Optional metadata to attach to the item. + * @returns The created item info. + */ + upload(name: string, content: ReadableStream | Blob | string, options?: AiSearchUploadItemOptions): Promise; + /** + * Upload a file and poll until processing completes. + * Behaves as an upsert: if an item with the same filename already exists, + * it is overwritten and re-indexed. + * @param name Filename for the uploaded item. + * @param content File content as a ReadableStream, Blob, or string. + * @param options Optional metadata and polling configuration. + * @returns The item info after processing completes (or timeout). + */ + uploadAndPoll(name: string, content: ReadableStream | Blob | string, options?: AiSearchUploadItemOptions & { + /** Polling interval in milliseconds (default 1000). */ + pollIntervalMs?: number; + /** Maximum time to wait in milliseconds (default 30000). */ + timeoutMs?: number; + }): Promise; + /** + * Get an item by ID. + * @param itemId The item identifier. + * @returns Item service for info, download, sync, logs, and chunks operations. + */ + get(itemId: string): AiSearchItem; + /** + * Delete an item from the instance. + * @param itemId The item identifier. + */ + delete(itemId: string): Promise; +} +/** + * Single job service for an AI Search instance. + * Provides info, logs, and cancel operations for a specific job. + */ +declare abstract class AiSearchJob { + /** Get metadata about this job. */ + info(): Promise; + /** Get logs for this job. */ + logs(params?: AiSearchJobLogsParams): Promise; + /** + * Cancel a running job. + * @returns The updated job info. + * @throws AiSearchNotFoundError if the job does not exist. + */ + cancel(): Promise; +} +/** + * Jobs collection service for an AI Search instance. + * Provides list, create, and access to individual jobs. + */ +declare abstract class AiSearchJobs { + /** List jobs for this instance. */ + list(params?: AiSearchListJobsParams): Promise; + /** + * Create a new indexing job. + * @param params Optional job parameters. + * @returns The created job info. + */ + create(params?: AiSearchCreateJobParams): Promise; + /** + * Get a job by ID. + * @param jobId The job identifier. + * @returns Job service for info, logs, and cancel operations. + */ + get(jobId: string): AiSearchJob; +} +// ============ AI Search Binding Classes ============ +/** + * Instance-level AI Search service. + * + * Used as: + * - The return type of `AiSearchNamespace.get(name)` (namespace binding) + * - The type of `env.BLOG_SEARCH` (single instance binding via `ai_search`) + * + * Provides search, chat, update, stats, items, and jobs operations. + * + * @example + * ```ts + * // Via namespace binding + * const instance = env.AI_SEARCH.get("blog"); + * const results = await instance.search({ + * query: "How does caching work?", + * }); + * + * // Via single instance binding + * const results = await env.BLOG_SEARCH.search({ + * messages: [{ role: "user", content: "How does caching work?" }], + * }); + * ``` + */ +declare abstract class AiSearchInstance { + /** + * Search the AI Search instance for relevant chunks. + * @param params Search request with query or messages and optional AI search options. + * @returns Search response with matching chunks and search query. + */ + search(params: AiSearchSearchRequest): Promise; + /** + * Generate chat completions with AI Search context (streaming). + * @param params Chat completions request with stream: true. + * @returns ReadableStream of server-sent events. + */ + chatCompletions(params: AiSearchChatCompletionsRequest & { + stream: true; + }): Promise; + /** + * Generate chat completions with AI Search context. + * @param params Chat completions request. + * @returns Chat completion response with choices and RAG chunks. + */ + chatCompletions(params: AiSearchChatCompletionsRequest): Promise; + /** + * Update the instance configuration. + * @param config Partial configuration to update. + * @returns Updated instance info. + */ + update(config: Partial): Promise; + /** Get metadata about this instance. */ + info(): Promise; + /** + * Get instance statistics (item count, indexing status, etc.). + * @returns Statistics with counts per status, last activity time, and engine details. + */ + stats(): Promise; + /** Items collection — list, upload, and manage items in this instance. */ + get items(): AiSearchItems; + /** Jobs collection — list, create, and inspect indexing jobs. */ + get jobs(): AiSearchJobs; +} +/** + * Namespace-level AI Search service. + * + * Used as the type of `env.AI_SEARCH` (namespace binding via `ai_search_namespaces`). + * Scoped to a single namespace. Provides dynamic instance access, creation, deletion, + * and multi-instance search/chat operations. + * + * @example + * ```ts + * // Access an instance within the namespace + * const blog = env.AI_SEARCH.get("blog"); + * const results = await blog.search({ query: "How does caching work?" }); + * + * // List all instances in the namespace + * const instances = await env.AI_SEARCH.list(); + * + * // Create a new instance with built-in storage + * const tenant = await env.AI_SEARCH.create({ id: "tenant-123" }); + * + * // Upload items into the instance + * await tenant.items.upload("doc.pdf", fileContent); + * + * // Search across multiple instances + * const multi = await env.AI_SEARCH.search({ + * query: "caching", + * ai_search_options: { instance_ids: ["blog", "docs"] }, + * }); + * + * // Delete an instance + * await env.AI_SEARCH.delete("tenant-123"); + * ``` + */ +declare abstract class AiSearchNamespace { + /** + * Get an instance by name within the bound namespace. + * @param name Instance name. + * @returns Instance service for search, chat, update, stats, items, and jobs. + */ + get(name: string): AiSearchInstance; + /** + * List instances in the bound namespace. + * @param params Optional pagination, search, and ordering parameters. + * @returns Array of instance metadata with pagination info. + */ + list(params?: AiSearchListInstancesParams): Promise; + /** + * Create a new instance within the bound namespace. + * @param config Instance configuration. Only `id` is required — omit `type` and `source` to create with built-in storage. + * @returns Instance service for the newly created instance. + * + * @example + * ```ts + * // Create with built-in storage (upload items manually) + * const instance = await env.AI_SEARCH.create({ id: "my-search" }); + * + * // Create with web crawler source + * const instance = await env.AI_SEARCH.create({ + * id: "docs-search", + * type: "web-crawler", + * source: "https://developers.cloudflare.com", + * }); + * ``` + */ + create(config: AiSearchConfig): Promise; + /** + * Delete an instance from the bound namespace. + * @param name Instance name to delete. + */ + delete(name: string): Promise; + /** + * Search across multiple instances within the bound namespace. + * Fans out to the specified instance_ids and merges results. + * @param params Search request with required `ai_search_options.instance_ids`. + * @returns Search response with chunks tagged by instance_id and optional partial-failure errors. + */ + search(params: AiSearchMultiSearchRequest): Promise; + /** + * Generate chat completions across multiple instances within the bound namespace (streaming). + * Fans out to the specified instance_ids, merges context, and generates a response. + * @param params Chat completions request with stream: true and required `ai_search_options.instance_ids`. + * @returns ReadableStream of server-sent events. + */ + chatCompletions(params: AiSearchMultiChatCompletionsRequest & { + stream: true; + }): Promise; + /** + * Generate chat completions across multiple instances within the bound namespace. + * Fans out to the specified instance_ids, merges context, and generates a response. + * @param params Chat completions request with required `ai_search_options.instance_ids`. + * @returns Chat completion response with choices, chunks tagged by instance_id, and optional partial-failure errors. + */ + chatCompletions(params: AiSearchMultiChatCompletionsRequest): Promise; +} +type AiImageClassificationInput = { + image: number[]; +}; +type AiImageClassificationOutput = { + score?: number; + label?: string; +}[]; +declare abstract class BaseAiImageClassification { + inputs: AiImageClassificationInput; + postProcessedOutputs: AiImageClassificationOutput; +} +type AiImageToTextInput = { + image: number[]; + prompt?: string; + max_tokens?: number; + temperature?: number; + top_p?: number; + top_k?: number; + seed?: number; + repetition_penalty?: number; + frequency_penalty?: number; + presence_penalty?: number; + raw?: boolean; + messages?: RoleScopedChatInput[]; +}; +type AiImageToTextOutput = { + description: string; +}; +declare abstract class BaseAiImageToText { + inputs: AiImageToTextInput; + postProcessedOutputs: AiImageToTextOutput; +} +type AiImageTextToTextInput = { + image: string; + prompt?: string; + max_tokens?: number; + temperature?: number; + ignore_eos?: boolean; + top_p?: number; + top_k?: number; + seed?: number; + repetition_penalty?: number; + frequency_penalty?: number; + presence_penalty?: number; + raw?: boolean; + messages?: RoleScopedChatInput[]; +}; +type AiImageTextToTextOutput = { + description: string; +}; +declare abstract class BaseAiImageTextToText { + inputs: AiImageTextToTextInput; + postProcessedOutputs: AiImageTextToTextOutput; +} +type AiMultimodalEmbeddingsInput = { + image: string; + text: string[]; +}; +type AiIMultimodalEmbeddingsOutput = { + data: number[][]; + shape: number[]; +}; +declare abstract class BaseAiMultimodalEmbeddings { + inputs: AiImageTextToTextInput; + postProcessedOutputs: AiImageTextToTextOutput; +} +type AiObjectDetectionInput = { + image: number[]; +}; +type AiObjectDetectionOutput = { + score?: number; + label?: string; +}[]; +declare abstract class BaseAiObjectDetection { + inputs: AiObjectDetectionInput; + postProcessedOutputs: AiObjectDetectionOutput; +} +type AiSentenceSimilarityInput = { + source: string; + sentences: string[]; +}; +type AiSentenceSimilarityOutput = number[]; +declare abstract class BaseAiSentenceSimilarity { + inputs: AiSentenceSimilarityInput; + postProcessedOutputs: AiSentenceSimilarityOutput; +} +type AiAutomaticSpeechRecognitionInput = { + audio: number[]; +}; +type AiAutomaticSpeechRecognitionOutput = { + text?: string; + words?: { + word: string; + start: number; + end: number; + }[]; + vtt?: string; +}; +declare abstract class BaseAiAutomaticSpeechRecognition { + inputs: AiAutomaticSpeechRecognitionInput; + postProcessedOutputs: AiAutomaticSpeechRecognitionOutput; +} +type AiSummarizationInput = { + input_text: string; + max_length?: number; +}; +type AiSummarizationOutput = { + summary: string; +}; +declare abstract class BaseAiSummarization { + inputs: AiSummarizationInput; + postProcessedOutputs: AiSummarizationOutput; +} +type AiTextClassificationInput = { + text: string; +}; +type AiTextClassificationOutput = { + score?: number; + label?: string; +}[]; +declare abstract class BaseAiTextClassification { + inputs: AiTextClassificationInput; + postProcessedOutputs: AiTextClassificationOutput; +} +type AiTextEmbeddingsInput = { + text: string | string[]; +}; +type AiTextEmbeddingsOutput = { + shape: number[]; + data: number[][]; +}; +declare abstract class BaseAiTextEmbeddings { + inputs: AiTextEmbeddingsInput; + postProcessedOutputs: AiTextEmbeddingsOutput; +} +type RoleScopedChatInput = { + role: "user" | "assistant" | "system" | "tool" | (string & NonNullable); + content: string; + name?: string; +}; +type AiTextGenerationToolLegacyInput = { + name: string; + description: string; + parameters?: { + type: "object" | (string & NonNullable); + properties: { + [key: string]: { + type: string; + description?: string; + }; + }; + required: string[]; + }; +}; +type AiTextGenerationToolInput = { + type: "function" | (string & NonNullable); + function: { + name: string; + description: string; + parameters?: { + type: "object" | (string & NonNullable); + properties: { + [key: string]: { + type: string; + description?: string; + }; + }; + required: string[]; + }; + }; +}; +type AiTextGenerationFunctionsInput = { + name: string; + code: string; +}; +type AiTextGenerationResponseFormat = { + type: string; + json_schema?: any; +}; +type AiTextGenerationInput = { + prompt?: string; + raw?: boolean; + stream?: boolean; + max_tokens?: number; + temperature?: number; + top_p?: number; + top_k?: number; + seed?: number; + repetition_penalty?: number; + frequency_penalty?: number; + presence_penalty?: number; + messages?: RoleScopedChatInput[]; + response_format?: AiTextGenerationResponseFormat; + tools?: AiTextGenerationToolInput[] | AiTextGenerationToolLegacyInput[] | (object & NonNullable); + functions?: AiTextGenerationFunctionsInput[]; +}; +type AiTextGenerationToolLegacyOutput = { + name: string; + arguments: unknown; +}; +type AiTextGenerationToolOutput = { + id: string; + type: "function"; + function: { + name: string; + arguments: string; + }; +}; +type UsageTags = { + prompt_tokens: number; + completion_tokens: number; + total_tokens: number; +}; +type AiTextGenerationOutput = { + response?: string; + tool_calls?: AiTextGenerationToolLegacyOutput[] & AiTextGenerationToolOutput[]; + usage?: UsageTags; +}; +declare abstract class BaseAiTextGeneration { + inputs: AiTextGenerationInput; + postProcessedOutputs: AiTextGenerationOutput; +} +type AiTextToSpeechInput = { + prompt: string; + lang?: string; +}; +type AiTextToSpeechOutput = Uint8Array | { + audio: string; +}; +declare abstract class BaseAiTextToSpeech { + inputs: AiTextToSpeechInput; + postProcessedOutputs: AiTextToSpeechOutput; +} +type AiTextToImageInput = { + prompt: string; + negative_prompt?: string; + height?: number; + width?: number; + image?: number[]; + image_b64?: string; + mask?: number[]; + num_steps?: number; + strength?: number; + guidance?: number; + seed?: number; +}; +type AiTextToImageOutput = ReadableStream; +declare abstract class BaseAiTextToImage { + inputs: AiTextToImageInput; + postProcessedOutputs: AiTextToImageOutput; +} +type AiTranslationInput = { + text: string; + target_lang: string; + source_lang?: string; +}; +type AiTranslationOutput = { + translated_text?: string; +}; +declare abstract class BaseAiTranslation { + inputs: AiTranslationInput; + postProcessedOutputs: AiTranslationOutput; +} +/** + * Workers AI support for OpenAI's Chat Completions API + */ +type ChatCompletionContentPartText = { + type: "text"; + text: string; +}; +type ChatCompletionContentPartImage = { + type: "image_url"; + image_url: { + url: string; + detail?: "auto" | "low" | "high"; + }; +}; +type ChatCompletionContentPartInputAudio = { + type: "input_audio"; + input_audio: { + /** Base64 encoded audio data. */ + data: string; + format: "wav" | "mp3"; + }; +}; +type ChatCompletionContentPartFile = { + type: "file"; + file: { + /** Base64 encoded file data. */ + file_data?: string; + /** The ID of an uploaded file. */ + file_id?: string; + filename?: string; + }; +}; +type ChatCompletionContentPartRefusal = { + type: "refusal"; + refusal: string; +}; +type ChatCompletionContentPart = ChatCompletionContentPartText | ChatCompletionContentPartImage | ChatCompletionContentPartInputAudio | ChatCompletionContentPartFile; +type FunctionDefinition = { + name: string; + description?: string; + parameters?: Record; + strict?: boolean | null; +}; +type ChatCompletionFunctionTool = { + type: "function"; + function: FunctionDefinition; +}; +type ChatCompletionCustomToolGrammarFormat = { + type: "grammar"; + grammar: { + definition: string; + syntax: "lark" | "regex"; + }; +}; +type ChatCompletionCustomToolTextFormat = { + type: "text"; +}; +type ChatCompletionCustomToolFormat = ChatCompletionCustomToolTextFormat | ChatCompletionCustomToolGrammarFormat; +type ChatCompletionCustomTool = { + type: "custom"; + custom: { + name: string; + description?: string; + format?: ChatCompletionCustomToolFormat; + }; +}; +type ChatCompletionTool = ChatCompletionFunctionTool | ChatCompletionCustomTool; +type ChatCompletionMessageFunctionToolCall = { + id: string; + type: "function"; + function: { + name: string; + /** JSON-encoded arguments string. */ + arguments: string; + }; +}; +type ChatCompletionMessageCustomToolCall = { + id: string; + type: "custom"; + custom: { + name: string; + input: string; + }; +}; +type ChatCompletionMessageToolCall = ChatCompletionMessageFunctionToolCall | ChatCompletionMessageCustomToolCall; +type ChatCompletionToolChoiceFunction = { + type: "function"; + function: { + name: string; + }; +}; +type ChatCompletionToolChoiceCustom = { + type: "custom"; + custom: { + name: string; + }; +}; +type ChatCompletionToolChoiceAllowedTools = { + type: "allowed_tools"; + allowed_tools: { + mode: "auto" | "required"; + tools: Array>; + }; +}; +type ChatCompletionToolChoiceOption = "none" | "auto" | "required" | ChatCompletionToolChoiceFunction | ChatCompletionToolChoiceCustom | ChatCompletionToolChoiceAllowedTools; +type DeveloperMessage = { + role: "developer"; + content: string | Array<{ + type: "text"; + text: string; + }>; + name?: string; +}; +type SystemMessage = { + role: "system"; + content: string | Array<{ + type: "text"; + text: string; + }>; + name?: string; +}; +/** + * Permissive merged content part used inside UserMessage arrays. + * + * Cabidela has a limitation where anyOf/oneOf with enum-based discrimination + * inside nested array items does not correctly match different branches for + * different array elements, so the schema uses a single merged object. + */ +type UserMessageContentPart = { + type: "text" | "image_url" | "input_audio" | "file"; + text?: string; + image_url?: { + url?: string; + detail?: "auto" | "low" | "high"; + }; + input_audio?: { + data?: string; + format?: "wav" | "mp3"; + }; + file?: { + file_data?: string; + file_id?: string; + filename?: string; + }; +}; +type UserMessage = { + role: "user"; + content: string | Array; + name?: string; +}; +type AssistantMessageContentPart = { + type: "text" | "refusal"; + text?: string; + refusal?: string; +}; +type AssistantMessage = { + role: "assistant"; + content?: string | null | Array; + refusal?: string | null; + name?: string; + audio?: { + id: string; + }; + tool_calls?: Array; + function_call?: { + name: string; + arguments: string; + }; +}; +type ToolMessage = { + role: "tool"; + content: string | Array<{ + type: "text"; + text: string; + }>; + tool_call_id: string; +}; +type FunctionMessage = { + role: "function"; + content: string; + name: string; +}; +type ChatCompletionMessageParam = DeveloperMessage | SystemMessage | UserMessage | AssistantMessage | ToolMessage | FunctionMessage; +type ChatCompletionsResponseFormatText = { + type: "text"; +}; +type ChatCompletionsResponseFormatJSONObject = { + type: "json_object"; +}; +type ResponseFormatJSONSchema = { + type: "json_schema"; + json_schema: { + name: string; + description?: string; + schema?: Record; + strict?: boolean | null; + }; +}; +type ResponseFormat = ChatCompletionsResponseFormatText | ChatCompletionsResponseFormatJSONObject | ResponseFormatJSONSchema; +type ChatCompletionsStreamOptions = { + include_usage?: boolean; + include_obfuscation?: boolean; +}; +type PredictionContent = { + type: "content"; + content: string | Array<{ + type: "text"; + text: string; + }>; +}; +type AudioParams = { + voice: string | { + id: string; + }; + format: "wav" | "aac" | "mp3" | "flac" | "opus" | "pcm16"; +}; +type WebSearchUserLocation = { + type: "approximate"; + approximate: { + city?: string; + country?: string; + region?: string; + timezone?: string; + }; +}; +type WebSearchOptions = { + search_context_size?: "low" | "medium" | "high"; + user_location?: WebSearchUserLocation; +}; +type ChatTemplateKwargs = { + /** Whether to enable reasoning, enabled by default. */ + enable_thinking?: boolean; + /** If false, preserves reasoning context between turns. */ + clear_thinking?: boolean; +}; +/** Shared optional properties used by both Prompt and Messages input branches. */ +type ChatCompletionsCommonOptions = { + model?: string; + audio?: AudioParams; + frequency_penalty?: number | null; + logit_bias?: Record | null; + logprobs?: boolean | null; + top_logprobs?: number | null; + max_tokens?: number | null; + max_completion_tokens?: number | null; + metadata?: Record | null; + modalities?: Array<"text" | "audio"> | null; + n?: number | null; + parallel_tool_calls?: boolean; + prediction?: PredictionContent; + presence_penalty?: number | null; + reasoning_effort?: "low" | "medium" | "high" | null; + chat_template_kwargs?: ChatTemplateKwargs; + response_format?: ResponseFormat; + seed?: number | null; + service_tier?: "auto" | "default" | "flex" | "scale" | "priority" | null; + stop?: string | Array | null; + store?: boolean | null; + stream?: boolean | null; + stream_options?: ChatCompletionsStreamOptions; + temperature?: number | null; + tool_choice?: ChatCompletionToolChoiceOption; + tools?: Array; + top_p?: number | null; + user?: string; + web_search_options?: WebSearchOptions; + function_call?: "none" | "auto" | { + name: string; + }; + functions?: Array; +}; +type PromptTokensDetails = { + cached_tokens?: number; + audio_tokens?: number; +}; +type CompletionTokensDetails = { + reasoning_tokens?: number; + audio_tokens?: number; + accepted_prediction_tokens?: number; + rejected_prediction_tokens?: number; +}; +type CompletionUsage = { + prompt_tokens: number; + completion_tokens: number; + total_tokens: number; + prompt_tokens_details?: PromptTokensDetails; + completion_tokens_details?: CompletionTokensDetails; +}; +type ChatCompletionTopLogprob = { + token: string; + logprob: number; + bytes: Array | null; +}; +type ChatCompletionTokenLogprob = { + token: string; + logprob: number; + bytes: Array | null; + top_logprobs: Array; +}; +type ChatCompletionAudio = { + id: string; + /** Base64 encoded audio bytes. */ + data: string; + expires_at: number; + transcript: string; +}; +type ChatCompletionUrlCitation = { + type: "url_citation"; + url_citation: { + url: string; + title: string; + start_index: number; + end_index: number; + }; +}; +type ChatCompletionResponseMessage = { + role: "assistant"; + content: string | null; + refusal: string | null; + annotations?: Array; + audio?: ChatCompletionAudio; + tool_calls?: Array; + function_call?: { + name: string; + arguments: string; + } | null; +}; +type ChatCompletionLogprobs = { + content: Array | null; + refusal?: Array | null; +}; +type ChatCompletionChoice = { + index: number; + message: ChatCompletionResponseMessage; + finish_reason: "stop" | "length" | "tool_calls" | "content_filter" | "function_call"; + logprobs: ChatCompletionLogprobs | null; +}; +type ChatCompletionsPromptInput = { + prompt: string; +} & ChatCompletionsCommonOptions; +type ChatCompletionsMessagesInput = { + messages: Array; +} & ChatCompletionsCommonOptions; +type ChatCompletionsOutput = { + id: string; + object: string; + created: number; + model: string; + choices: Array; + usage?: CompletionUsage; + system_fingerprint?: string | null; + service_tier?: "auto" | "default" | "flex" | "scale" | "priority" | null; +}; +/** + * Workers AI support for OpenAI's Responses API + * Reference: https://github.com/openai/openai-node/blob/master/src/resources/responses/responses.ts + * + * It's a stripped down version from its source. + * It currently supports basic function calling, json mode and accepts images as input. + * + * It does not include types for WebSearch, CodeInterpreter, FileInputs, MCP, CustomTools. + * We plan to add those incrementally as model + platform capabilities evolve. + */ +type ResponsesInput = { + background?: boolean | null; + conversation?: string | ResponseConversationParam | null; + include?: Array | null; + input?: string | ResponseInput; + instructions?: string | null; + max_output_tokens?: number | null; + parallel_tool_calls?: boolean | null; + previous_response_id?: string | null; + prompt_cache_key?: string; + reasoning?: Reasoning | null; + safety_identifier?: string; + service_tier?: "auto" | "default" | "flex" | "scale" | "priority" | null; + stream?: boolean | null; + stream_options?: StreamOptions | null; + temperature?: number | null; + text?: ResponseTextConfig; + tool_choice?: ToolChoiceOptions | ToolChoiceFunction; + tools?: Array; + top_p?: number | null; + truncation?: "auto" | "disabled" | null; +}; +type ResponsesOutput = { + id?: string; + created_at?: number; + output_text?: string; + error?: ResponseError | null; + incomplete_details?: ResponseIncompleteDetails | null; + instructions?: string | Array | null; + object?: "response"; + output?: Array; + parallel_tool_calls?: boolean; + temperature?: number | null; + tool_choice?: ToolChoiceOptions | ToolChoiceFunction; + tools?: Array; + top_p?: number | null; + max_output_tokens?: number | null; + previous_response_id?: string | null; + prompt?: ResponsePrompt | null; + reasoning?: Reasoning | null; + safety_identifier?: string; + service_tier?: "auto" | "default" | "flex" | "scale" | "priority" | null; + status?: ResponseStatus; + text?: ResponseTextConfig; + truncation?: "auto" | "disabled" | null; + usage?: ResponseUsage; +}; +type EasyInputMessage = { + content: string | ResponseInputMessageContentList; + role: "user" | "assistant" | "system" | "developer"; + type?: "message"; +}; +type ResponsesFunctionTool = { + name: string; + parameters: { + [key: string]: unknown; + } | null; + strict: boolean | null; + type: "function"; + description?: string | null; +}; +type ResponseIncompleteDetails = { + reason?: "max_output_tokens" | "content_filter"; +}; +type ResponsePrompt = { + id: string; + variables?: { + [key: string]: string | ResponseInputText | ResponseInputImage; + } | null; + version?: string | null; +}; +type Reasoning = { + effort?: ReasoningEffort | null; + generate_summary?: "auto" | "concise" | "detailed" | null; + summary?: "auto" | "concise" | "detailed" | null; +}; +type ResponseContent = ResponseInputText | ResponseInputImage | ResponseOutputText | ResponseOutputRefusal | ResponseContentReasoningText; +type ResponseContentReasoningText = { + text: string; + type: "reasoning_text"; +}; +type ResponseConversationParam = { + id: string; +}; +type ResponseCreatedEvent = { + response: Response; + sequence_number: number; + type: "response.created"; +}; +type ResponseCustomToolCallOutput = { + call_id: string; + output: string | Array; + type: "custom_tool_call_output"; + id?: string; +}; +type ResponseError = { + code: "server_error" | "rate_limit_exceeded" | "invalid_prompt" | "vector_store_timeout" | "invalid_image" | "invalid_image_format" | "invalid_base64_image" | "invalid_image_url" | "image_too_large" | "image_too_small" | "image_parse_error" | "image_content_policy_violation" | "invalid_image_mode" | "image_file_too_large" | "unsupported_image_media_type" | "empty_image_file" | "failed_to_download_image" | "image_file_not_found"; + message: string; +}; +type ResponseErrorEvent = { + code: string | null; + message: string; + param: string | null; + sequence_number: number; + type: "error"; +}; +type ResponseFailedEvent = { + response: Response; + sequence_number: number; + type: "response.failed"; +}; +type ResponseFormatText = { + type: "text"; +}; +type ResponseFormatJSONObject = { + type: "json_object"; +}; +type ResponseFormatTextConfig = ResponseFormatText | ResponseFormatTextJSONSchemaConfig | ResponseFormatJSONObject; +type ResponseFormatTextJSONSchemaConfig = { + name: string; + schema: { + [key: string]: unknown; + }; + type: "json_schema"; + description?: string; + strict?: boolean | null; +}; +type ResponseFunctionCallArgumentsDeltaEvent = { + delta: string; + item_id: string; + output_index: number; + sequence_number: number; + type: "response.function_call_arguments.delta"; +}; +type ResponseFunctionCallArgumentsDoneEvent = { + arguments: string; + item_id: string; + name: string; + output_index: number; + sequence_number: number; + type: "response.function_call_arguments.done"; +}; +type ResponseFunctionCallOutputItem = ResponseInputTextContent | ResponseInputImageContent; +type ResponseFunctionCallOutputItemList = Array; +type ResponseFunctionToolCall = { + arguments: string; + call_id: string; + name: string; + type: "function_call"; + id?: string; + status?: "in_progress" | "completed" | "incomplete"; +}; +interface ResponseFunctionToolCallItem extends ResponseFunctionToolCall { + id: string; +} +type ResponseFunctionToolCallOutputItem = { + id: string; + call_id: string; + output: string | Array; + type: "function_call_output"; + status?: "in_progress" | "completed" | "incomplete"; +}; +type ResponseIncludable = "message.input_image.image_url" | "message.output_text.logprobs"; +type ResponseIncompleteEvent = { + response: Response; + sequence_number: number; + type: "response.incomplete"; +}; +type ResponseInput = Array; +type ResponseInputContent = ResponseInputText | ResponseInputImage; +type ResponseInputImage = { + detail: "low" | "high" | "auto"; + type: "input_image"; + /** + * Base64 encoded image + */ + image_url?: string | null; +}; +type ResponseInputImageContent = { + type: "input_image"; + detail?: "low" | "high" | "auto" | null; + /** + * Base64 encoded image + */ + image_url?: string | null; +}; +type ResponseInputItem = EasyInputMessage | ResponseInputItemMessage | ResponseOutputMessage | ResponseFunctionToolCall | ResponseInputItemFunctionCallOutput | ResponseReasoningItem; +type ResponseInputItemFunctionCallOutput = { + call_id: string; + output: string | ResponseFunctionCallOutputItemList; + type: "function_call_output"; + id?: string | null; + status?: "in_progress" | "completed" | "incomplete" | null; +}; +type ResponseInputItemMessage = { + content: ResponseInputMessageContentList; + role: "user" | "system" | "developer"; + status?: "in_progress" | "completed" | "incomplete"; + type?: "message"; +}; +type ResponseInputMessageContentList = Array; +type ResponseInputMessageItem = { + id: string; + content: ResponseInputMessageContentList; + role: "user" | "system" | "developer"; + status?: "in_progress" | "completed" | "incomplete"; + type?: "message"; +}; +type ResponseInputText = { + text: string; + type: "input_text"; +}; +type ResponseInputTextContent = { + text: string; + type: "input_text"; +}; +type ResponseItem = ResponseInputMessageItem | ResponseOutputMessage | ResponseFunctionToolCallItem | ResponseFunctionToolCallOutputItem; +type ResponseOutputItem = ResponseOutputMessage | ResponseFunctionToolCall | ResponseReasoningItem; +type ResponseOutputItemAddedEvent = { + item: ResponseOutputItem; + output_index: number; + sequence_number: number; + type: "response.output_item.added"; +}; +type ResponseOutputItemDoneEvent = { + item: ResponseOutputItem; + output_index: number; + sequence_number: number; + type: "response.output_item.done"; +}; +type ResponseOutputMessage = { + id: string; + content: Array; + role: "assistant"; + status: "in_progress" | "completed" | "incomplete"; + type: "message"; +}; +type ResponseOutputRefusal = { + refusal: string; + type: "refusal"; +}; +type ResponseOutputText = { + text: string; + type: "output_text"; + logprobs?: Array; +}; +type ResponseReasoningItem = { + id: string; + summary: Array; + type: "reasoning"; + content?: Array; + encrypted_content?: string | null; + status?: "in_progress" | "completed" | "incomplete"; +}; +type ResponseReasoningSummaryItem = { + text: string; + type: "summary_text"; +}; +type ResponseReasoningContentItem = { + text: string; + type: "reasoning_text"; +}; +type ResponseReasoningTextDeltaEvent = { + content_index: number; + delta: string; + item_id: string; + output_index: number; + sequence_number: number; + type: "response.reasoning_text.delta"; +}; +type ResponseReasoningTextDoneEvent = { + content_index: number; + item_id: string; + output_index: number; + sequence_number: number; + text: string; + type: "response.reasoning_text.done"; +}; +type ResponseRefusalDeltaEvent = { + content_index: number; + delta: string; + item_id: string; + output_index: number; + sequence_number: number; + type: "response.refusal.delta"; +}; +type ResponseRefusalDoneEvent = { + content_index: number; + item_id: string; + output_index: number; + refusal: string; + sequence_number: number; + type: "response.refusal.done"; +}; +type ResponseStatus = "completed" | "failed" | "in_progress" | "cancelled" | "queued" | "incomplete"; +type ResponseStreamEvent = ResponseCompletedEvent | ResponseCreatedEvent | ResponseErrorEvent | ResponseFunctionCallArgumentsDeltaEvent | ResponseFunctionCallArgumentsDoneEvent | ResponseFailedEvent | ResponseIncompleteEvent | ResponseOutputItemAddedEvent | ResponseOutputItemDoneEvent | ResponseReasoningTextDeltaEvent | ResponseReasoningTextDoneEvent | ResponseRefusalDeltaEvent | ResponseRefusalDoneEvent | ResponseTextDeltaEvent | ResponseTextDoneEvent; +type ResponseCompletedEvent = { + response: Response; + sequence_number: number; + type: "response.completed"; +}; +type ResponseTextConfig = { + format?: ResponseFormatTextConfig; + verbosity?: "low" | "medium" | "high" | null; +}; +type ResponseTextDeltaEvent = { + content_index: number; + delta: string; + item_id: string; + logprobs: Array; + output_index: number; + sequence_number: number; + type: "response.output_text.delta"; +}; +type ResponseTextDoneEvent = { + content_index: number; + item_id: string; + logprobs: Array; + output_index: number; + sequence_number: number; + text: string; + type: "response.output_text.done"; +}; +type Logprob = { + token: string; + logprob: number; + top_logprobs?: Array; +}; +type TopLogprob = { + token?: string; + logprob?: number; +}; +type ResponseUsage = { + input_tokens: number; + output_tokens: number; + total_tokens: number; +}; +type Tool = ResponsesFunctionTool; +type ToolChoiceFunction = { + name: string; + type: "function"; +}; +type ToolChoiceOptions = "none"; +type ReasoningEffort = "minimal" | "low" | "medium" | "high" | null; +type StreamOptions = { + include_obfuscation?: boolean; +}; +/** Marks keys from T that aren't in U as optional never */ +type Without = { + [P in Exclude]?: never; +}; +/** Either T or U, but not both (mutually exclusive) */ +type XOR = (T & Without) | (U & Without); +type Ai_Cf_Baai_Bge_Base_En_V1_5_Input = { + text: string | string[]; + /** + * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. + */ + pooling?: "mean" | "cls"; +} | { + /** + * Batch of the embeddings requests to run using async-queue + */ + requests: { + text: string | string[]; + /** + * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. + */ + pooling?: "mean" | "cls"; + }[]; +}; +type Ai_Cf_Baai_Bge_Base_En_V1_5_Output = { + shape?: number[]; + /** + * Embeddings of the requested text values + */ + data?: number[][]; + /** + * The pooling method used in the embedding process. + */ + pooling?: "mean" | "cls"; +} | Ai_Cf_Baai_Bge_Base_En_V1_5_AsyncResponse; +interface Ai_Cf_Baai_Bge_Base_En_V1_5_AsyncResponse { + /** + * The async request id that can be used to obtain the results. + */ + request_id?: string; +} +declare abstract class Base_Ai_Cf_Baai_Bge_Base_En_V1_5 { + inputs: Ai_Cf_Baai_Bge_Base_En_V1_5_Input; + postProcessedOutputs: Ai_Cf_Baai_Bge_Base_En_V1_5_Output; +} +type Ai_Cf_Openai_Whisper_Input = string | { + /** + * An array of integers that represent the audio data constrained to 8-bit unsigned integer values + */ + audio: number[]; +}; +interface Ai_Cf_Openai_Whisper_Output { + /** + * The transcription + */ + text: string; + word_count?: number; + words?: { + word?: string; + /** + * The second this word begins in the recording + */ + start?: number; + /** + * The ending second when the word completes + */ + end?: number; + }[]; + vtt?: string; +} +declare abstract class Base_Ai_Cf_Openai_Whisper { + inputs: Ai_Cf_Openai_Whisper_Input; + postProcessedOutputs: Ai_Cf_Openai_Whisper_Output; +} +type Ai_Cf_Meta_M2M100_1_2B_Input = { + /** + * The text to be translated + */ + text: string; + /** + * The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified + */ + source_lang?: string; + /** + * The language code to translate the text into (e.g., 'es' for Spanish) + */ + target_lang: string; +} | { + /** + * Batch of the embeddings requests to run using async-queue + */ + requests: { + /** + * The text to be translated + */ + text: string; + /** + * The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified + */ + source_lang?: string; + /** + * The language code to translate the text into (e.g., 'es' for Spanish) + */ + target_lang: string; + }[]; +}; +type Ai_Cf_Meta_M2M100_1_2B_Output = { + /** + * The translated text in the target language + */ + translated_text?: string; +} | Ai_Cf_Meta_M2M100_1_2B_AsyncResponse; +interface Ai_Cf_Meta_M2M100_1_2B_AsyncResponse { + /** + * The async request id that can be used to obtain the results. + */ + request_id?: string; +} +declare abstract class Base_Ai_Cf_Meta_M2M100_1_2B { + inputs: Ai_Cf_Meta_M2M100_1_2B_Input; + postProcessedOutputs: Ai_Cf_Meta_M2M100_1_2B_Output; +} +type Ai_Cf_Baai_Bge_Small_En_V1_5_Input = { + text: string | string[]; + /** + * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. + */ + pooling?: "mean" | "cls"; +} | { + /** + * Batch of the embeddings requests to run using async-queue + */ + requests: { + text: string | string[]; + /** + * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. + */ + pooling?: "mean" | "cls"; + }[]; +}; +type Ai_Cf_Baai_Bge_Small_En_V1_5_Output = { + shape?: number[]; + /** + * Embeddings of the requested text values + */ + data?: number[][]; + /** + * The pooling method used in the embedding process. + */ + pooling?: "mean" | "cls"; +} | Ai_Cf_Baai_Bge_Small_En_V1_5_AsyncResponse; +interface Ai_Cf_Baai_Bge_Small_En_V1_5_AsyncResponse { + /** + * The async request id that can be used to obtain the results. + */ + request_id?: string; +} +declare abstract class Base_Ai_Cf_Baai_Bge_Small_En_V1_5 { + inputs: Ai_Cf_Baai_Bge_Small_En_V1_5_Input; + postProcessedOutputs: Ai_Cf_Baai_Bge_Small_En_V1_5_Output; +} +type Ai_Cf_Baai_Bge_Large_En_V1_5_Input = { + text: string | string[]; + /** + * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. + */ + pooling?: "mean" | "cls"; +} | { + /** + * Batch of the embeddings requests to run using async-queue + */ + requests: { + text: string | string[]; + /** + * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. + */ + pooling?: "mean" | "cls"; + }[]; +}; +type Ai_Cf_Baai_Bge_Large_En_V1_5_Output = { + shape?: number[]; + /** + * Embeddings of the requested text values + */ + data?: number[][]; + /** + * The pooling method used in the embedding process. + */ + pooling?: "mean" | "cls"; +} | Ai_Cf_Baai_Bge_Large_En_V1_5_AsyncResponse; +interface Ai_Cf_Baai_Bge_Large_En_V1_5_AsyncResponse { + /** + * The async request id that can be used to obtain the results. + */ + request_id?: string; +} +declare abstract class Base_Ai_Cf_Baai_Bge_Large_En_V1_5 { + inputs: Ai_Cf_Baai_Bge_Large_En_V1_5_Input; + postProcessedOutputs: Ai_Cf_Baai_Bge_Large_En_V1_5_Output; +} +type Ai_Cf_Unum_Uform_Gen2_Qwen_500M_Input = string | { + /** + * The input text prompt for the model to generate a response. + */ + prompt?: string; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * Controls the creativity of the AI's responses by adjusting how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; + image: number[] | (string & NonNullable); + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; +}; +interface Ai_Cf_Unum_Uform_Gen2_Qwen_500M_Output { + description?: string; +} +declare abstract class Base_Ai_Cf_Unum_Uform_Gen2_Qwen_500M { + inputs: Ai_Cf_Unum_Uform_Gen2_Qwen_500M_Input; + postProcessedOutputs: Ai_Cf_Unum_Uform_Gen2_Qwen_500M_Output; +} +type Ai_Cf_Openai_Whisper_Tiny_En_Input = string | { + /** + * An array of integers that represent the audio data constrained to 8-bit unsigned integer values + */ + audio: number[]; +}; +interface Ai_Cf_Openai_Whisper_Tiny_En_Output { + /** + * The transcription + */ + text: string; + word_count?: number; + words?: { + word?: string; + /** + * The second this word begins in the recording + */ + start?: number; + /** + * The ending second when the word completes + */ + end?: number; + }[]; + vtt?: string; +} +declare abstract class Base_Ai_Cf_Openai_Whisper_Tiny_En { + inputs: Ai_Cf_Openai_Whisper_Tiny_En_Input; + postProcessedOutputs: Ai_Cf_Openai_Whisper_Tiny_En_Output; +} +interface Ai_Cf_Openai_Whisper_Large_V3_Turbo_Input { + audio: string | { + body?: object; + contentType?: string; + }; + /** + * Supported tasks are 'translate' or 'transcribe'. + */ + task?: string; + /** + * The language of the audio being transcribed or translated. + */ + language?: string; + /** + * Preprocess the audio with a voice activity detection model. + */ + vad_filter?: boolean; + /** + * A text prompt to help provide context to the model on the contents of the audio. + */ + initial_prompt?: string; + /** + * The prefix appended to the beginning of the output of the transcription and can guide the transcription result. + */ + prefix?: string; + /** + * The number of beams to use in beam search decoding. Higher values may improve accuracy at the cost of speed. + */ + beam_size?: number; + /** + * Whether to condition on previous text during transcription. Setting to false may help prevent hallucination loops. + */ + condition_on_previous_text?: boolean; + /** + * Threshold for detecting no-speech segments. Segments with no-speech probability above this value are skipped. + */ + no_speech_threshold?: number; + /** + * Threshold for filtering out segments with high compression ratio, which often indicate repetitive or hallucinated text. + */ + compression_ratio_threshold?: number; + /** + * Threshold for filtering out segments with low average log probability, indicating low confidence. + */ + log_prob_threshold?: number; + /** + * Optional threshold (in seconds) to skip silent periods that may cause hallucinations. + */ + hallucination_silence_threshold?: number; +} +interface Ai_Cf_Openai_Whisper_Large_V3_Turbo_Output { + transcription_info?: { + /** + * The language of the audio being transcribed or translated. + */ + language?: string; + /** + * The confidence level or probability of the detected language being accurate, represented as a decimal between 0 and 1. + */ + language_probability?: number; + /** + * The total duration of the original audio file, in seconds. + */ + duration?: number; + /** + * The duration of the audio after applying Voice Activity Detection (VAD) to remove silent or irrelevant sections, in seconds. + */ + duration_after_vad?: number; + }; + /** + * The complete transcription of the audio. + */ + text: string; + /** + * The total number of words in the transcription. + */ + word_count?: number; + segments?: { + /** + * The starting time of the segment within the audio, in seconds. + */ + start?: number; + /** + * The ending time of the segment within the audio, in seconds. + */ + end?: number; + /** + * The transcription of the segment. + */ + text?: string; + /** + * The temperature used in the decoding process, controlling randomness in predictions. Lower values result in more deterministic outputs. + */ + temperature?: number; + /** + * The average log probability of the predictions for the words in this segment, indicating overall confidence. + */ + avg_logprob?: number; + /** + * The compression ratio of the input to the output, measuring how much the text was compressed during the transcription process. + */ + compression_ratio?: number; + /** + * The probability that the segment contains no speech, represented as a decimal between 0 and 1. + */ + no_speech_prob?: number; + words?: { + /** + * The individual word transcribed from the audio. + */ + word?: string; + /** + * The starting time of the word within the audio, in seconds. + */ + start?: number; + /** + * The ending time of the word within the audio, in seconds. + */ + end?: number; + }[]; + }[]; + /** + * The transcription in WebVTT format, which includes timing and text information for use in subtitles. + */ + vtt?: string; +} +declare abstract class Base_Ai_Cf_Openai_Whisper_Large_V3_Turbo { + inputs: Ai_Cf_Openai_Whisper_Large_V3_Turbo_Input; + postProcessedOutputs: Ai_Cf_Openai_Whisper_Large_V3_Turbo_Output; +} +type Ai_Cf_Baai_Bge_M3_Input = Ai_Cf_Baai_Bge_M3_Input_QueryAnd_Contexts | Ai_Cf_Baai_Bge_M3_Input_Embedding | { + /** + * Batch of the embeddings requests to run using async-queue + */ + requests: (Ai_Cf_Baai_Bge_M3_Input_QueryAnd_Contexts_1 | Ai_Cf_Baai_Bge_M3_Input_Embedding_1)[]; +}; +interface Ai_Cf_Baai_Bge_M3_Input_QueryAnd_Contexts { + /** + * A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts + */ + query?: string; + /** + * List of provided contexts. Note that the index in this array is important, as the response will refer to it. + */ + contexts: { + /** + * One of the provided context content + */ + text?: string; + }[]; + /** + * When provided with too long context should the model error out or truncate the context to fit? + */ + truncate_inputs?: boolean; +} +interface Ai_Cf_Baai_Bge_M3_Input_Embedding { + text: string | string[]; + /** + * When provided with too long context should the model error out or truncate the context to fit? + */ + truncate_inputs?: boolean; +} +interface Ai_Cf_Baai_Bge_M3_Input_QueryAnd_Contexts_1 { + /** + * A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts + */ + query?: string; + /** + * List of provided contexts. Note that the index in this array is important, as the response will refer to it. + */ + contexts: { + /** + * One of the provided context content + */ + text?: string; + }[]; + /** + * When provided with too long context should the model error out or truncate the context to fit? + */ + truncate_inputs?: boolean; +} +interface Ai_Cf_Baai_Bge_M3_Input_Embedding_1 { + text: string | string[]; + /** + * When provided with too long context should the model error out or truncate the context to fit? + */ + truncate_inputs?: boolean; +} +type Ai_Cf_Baai_Bge_M3_Output = Ai_Cf_Baai_Bge_M3_Output_Query | Ai_Cf_Baai_Bge_M3_Output_EmbeddingFor_Contexts | Ai_Cf_Baai_Bge_M3_Output_Embedding | Ai_Cf_Baai_Bge_M3_AsyncResponse; +interface Ai_Cf_Baai_Bge_M3_Output_Query { + response?: { + /** + * Index of the context in the request + */ + id?: number; + /** + * Score of the context under the index. + */ + score?: number; + }[]; +} +interface Ai_Cf_Baai_Bge_M3_Output_EmbeddingFor_Contexts { + response?: number[][]; + shape?: number[]; + /** + * The pooling method used in the embedding process. + */ + pooling?: "mean" | "cls"; +} +interface Ai_Cf_Baai_Bge_M3_Output_Embedding { + shape?: number[]; + /** + * Embeddings of the requested text values + */ + data?: number[][]; + /** + * The pooling method used in the embedding process. + */ + pooling?: "mean" | "cls"; +} +interface Ai_Cf_Baai_Bge_M3_AsyncResponse { + /** + * The async request id that can be used to obtain the results. + */ + request_id?: string; +} +declare abstract class Base_Ai_Cf_Baai_Bge_M3 { + inputs: Ai_Cf_Baai_Bge_M3_Input; + postProcessedOutputs: Ai_Cf_Baai_Bge_M3_Output; +} +interface Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Input { + /** + * A text description of the image you want to generate. + */ + prompt: string; + /** + * The number of diffusion steps; higher values can improve quality but take longer. + */ + steps?: number; +} +interface Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Output { + /** + * The generated image in Base64 format. + */ + image?: string; +} +declare abstract class Base_Ai_Cf_Black_Forest_Labs_Flux_1_Schnell { + inputs: Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Input; + postProcessedOutputs: Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Output; +} +type Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Input = Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Prompt | Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Messages; +interface Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Prompt { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + image?: number[] | (string & NonNullable); + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; + /** + * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + */ + lora?: string; +} +interface Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Messages { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role?: string; + /** + * The tool call id. If you don't know what to put here you can fall back to 000000001 + */ + tool_call_id?: string; + content?: string | { + /** + * Type of the content provided + */ + type?: string; + text?: string; + image_url?: { + /** + * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted + */ + url?: string; + }; + }[] | { + /** + * Type of the content provided + */ + type?: string; + text?: string; + image_url?: { + /** + * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted + */ + url?: string; + }; + }; + }[]; + image?: number[] | (string & NonNullable); + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + /** + * If true, the response will be streamed back incrementally. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Controls the creativity of the AI's responses by adjusting how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +type Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Output = { + /** + * The generated text response from the model + */ + response?: string; + /** + * An array of tool calls requests made during the response generation + */ + tool_calls?: { + /** + * The arguments passed to be passed to the tool call request + */ + arguments?: object; + /** + * The name of the tool to be called + */ + name?: string; + }[]; +}; +declare abstract class Base_Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct { + inputs: Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Input; + postProcessedOutputs: Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Output; +} +type Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Input = Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Prompt | Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Messages | Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Async_Batch; +interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Prompt { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + /** + * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + */ + lora?: string; + response_format?: Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Messages { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role: string; + content: string | { + /** + * Type of the content (text) + */ + type?: string; + /** + * Text content + */ + text?: string; + }[]; + }[]; + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + response_format?: Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode_1; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode_1 { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Async_Batch { + requests?: { + /** + * User-supplied reference. This field will be present in the response as well it can be used to reference the request and response. It's NOT validated to be unique. + */ + external_reference?: string; + /** + * Prompt for the text generation model + */ + prompt?: string; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; + response_format?: Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode_2; + }[]; +} +interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode_2 { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +type Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Output = { + /** + * The generated text response from the model + */ + response: string; + /** + * Usage statistics for the inference request + */ + usage?: { + /** + * Total number of tokens in input + */ + prompt_tokens?: number; + /** + * Total number of tokens in output + */ + completion_tokens?: number; + /** + * Total number of input and output tokens + */ + total_tokens?: number; + }; + /** + * An array of tool calls requests made during the response generation + */ + tool_calls?: { + /** + * The arguments passed to be passed to the tool call request + */ + arguments?: object; + /** + * The name of the tool to be called + */ + name?: string; + }[]; +} | string | Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_AsyncResponse; +interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_AsyncResponse { + /** + * The async request id that can be used to obtain the results. + */ + request_id?: string; +} +declare abstract class Base_Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast { + inputs: Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Input; + postProcessedOutputs: Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Output; +} +interface Ai_Cf_Meta_Llama_Guard_3_8B_Input { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender must alternate between 'user' and 'assistant'. + */ + role: "user" | "assistant"; + /** + * The content of the message as a string. + */ + content: string; + }[]; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Dictate the output format of the generated response. + */ + response_format?: { + /** + * Set to json_object to process and output generated text as JSON. + */ + type?: string; + }; +} +interface Ai_Cf_Meta_Llama_Guard_3_8B_Output { + response?: string | { + /** + * Whether the conversation is safe or not. + */ + safe?: boolean; + /** + * A list of what hazard categories predicted for the conversation, if the conversation is deemed unsafe. + */ + categories?: string[]; + }; + /** + * Usage statistics for the inference request + */ + usage?: { + /** + * Total number of tokens in input + */ + prompt_tokens?: number; + /** + * Total number of tokens in output + */ + completion_tokens?: number; + /** + * Total number of input and output tokens + */ + total_tokens?: number; + }; +} +declare abstract class Base_Ai_Cf_Meta_Llama_Guard_3_8B { + inputs: Ai_Cf_Meta_Llama_Guard_3_8B_Input; + postProcessedOutputs: Ai_Cf_Meta_Llama_Guard_3_8B_Output; +} +interface Ai_Cf_Baai_Bge_Reranker_Base_Input { + /** + * A query you wish to perform against the provided contexts. + */ + /** + * Number of returned results starting with the best score. + */ + top_k?: number; + /** + * List of provided contexts. Note that the index in this array is important, as the response will refer to it. + */ + contexts: { + /** + * One of the provided context content + */ + text?: string; + }[]; +} +interface Ai_Cf_Baai_Bge_Reranker_Base_Output { + response?: { + /** + * Index of the context in the request + */ + id?: number; + /** + * Score of the context under the index. + */ + score?: number; + }[]; +} +declare abstract class Base_Ai_Cf_Baai_Bge_Reranker_Base { + inputs: Ai_Cf_Baai_Bge_Reranker_Base_Input; + postProcessedOutputs: Ai_Cf_Baai_Bge_Reranker_Base_Output; +} +type Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Input = Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Prompt | Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Messages; +interface Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Prompt { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + /** + * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + */ + lora?: string; + response_format?: Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_JSON_Mode; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_JSON_Mode { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +interface Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Messages { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role: string; + /** + * The content of the message as a string. + */ + content: string; + }[]; + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + response_format?: Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_JSON_Mode_1; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_JSON_Mode_1 { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +type Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Output = { + /** + * The generated text response from the model + */ + response: string; + /** + * Usage statistics for the inference request + */ + usage?: { + /** + * Total number of tokens in input + */ + prompt_tokens?: number; + /** + * Total number of tokens in output + */ + completion_tokens?: number; + /** + * Total number of input and output tokens + */ + total_tokens?: number; + }; + /** + * An array of tool calls requests made during the response generation + */ + tool_calls?: { + /** + * The arguments passed to be passed to the tool call request + */ + arguments?: object; + /** + * The name of the tool to be called + */ + name?: string; + }[]; +}; +declare abstract class Base_Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct { + inputs: Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Input; + postProcessedOutputs: Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Output; +} +type Ai_Cf_Qwen_Qwq_32B_Input = Ai_Cf_Qwen_Qwq_32B_Prompt | Ai_Cf_Qwen_Qwq_32B_Messages; +interface Ai_Cf_Qwen_Qwq_32B_Prompt { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + /** + * JSON schema that should be fulfilled for the response. + */ + guided_json?: object; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Qwen_Qwq_32B_Messages { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role?: string; + /** + * The tool call id. If you don't know what to put here you can fall back to 000000001 + */ + tool_call_id?: string; + content?: string | { + /** + * Type of the content provided + */ + type?: string; + text?: string; + image_url?: { + /** + * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted + */ + url?: string; + }; + }[] | { + /** + * Type of the content provided + */ + type?: string; + text?: string; + image_url?: { + /** + * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted + */ + url?: string; + }; + }; + }[]; + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + /** + * JSON schema that should be fufilled for the response. + */ + guided_json?: object; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +type Ai_Cf_Qwen_Qwq_32B_Output = { + /** + * The generated text response from the model + */ + response: string; + /** + * Usage statistics for the inference request + */ + usage?: { + /** + * Total number of tokens in input + */ + prompt_tokens?: number; + /** + * Total number of tokens in output + */ + completion_tokens?: number; + /** + * Total number of input and output tokens + */ + total_tokens?: number; + }; + /** + * An array of tool calls requests made during the response generation + */ + tool_calls?: { + /** + * The arguments passed to be passed to the tool call request + */ + arguments?: object; + /** + * The name of the tool to be called + */ + name?: string; + }[]; +}; +declare abstract class Base_Ai_Cf_Qwen_Qwq_32B { + inputs: Ai_Cf_Qwen_Qwq_32B_Input; + postProcessedOutputs: Ai_Cf_Qwen_Qwq_32B_Output; +} +type Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Input = Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Prompt | Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Messages; +interface Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Prompt { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + /** + * JSON schema that should be fulfilled for the response. + */ + guided_json?: object; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Messages { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role?: string; + /** + * The tool call id. Must be supplied for tool calls for Mistral-3. If you don't know what to put here you can fall back to 000000001 + */ + tool_call_id?: string; + content?: string | { + /** + * Type of the content provided + */ + type?: string; + text?: string; + image_url?: { + /** + * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted + */ + url?: string; + }; + }[] | { + /** + * Type of the content provided + */ + type?: string; + text?: string; + image_url?: { + /** + * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted + */ + url?: string; + }; + }; + }[]; + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + /** + * JSON schema that should be fufilled for the response. + */ + guided_json?: object; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +type Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Output = { + /** + * The generated text response from the model + */ + response: string; + /** + * Usage statistics for the inference request + */ + usage?: { + /** + * Total number of tokens in input + */ + prompt_tokens?: number; + /** + * Total number of tokens in output + */ + completion_tokens?: number; + /** + * Total number of input and output tokens + */ + total_tokens?: number; + }; + /** + * An array of tool calls requests made during the response generation + */ + tool_calls?: { + /** + * The arguments passed to be passed to the tool call request + */ + arguments?: object; + /** + * The name of the tool to be called + */ + name?: string; + }[]; +}; +declare abstract class Base_Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct { + inputs: Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Input; + postProcessedOutputs: Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Output; +} +type Ai_Cf_Google_Gemma_3_12B_It_Input = Ai_Cf_Google_Gemma_3_12B_It_Prompt | Ai_Cf_Google_Gemma_3_12B_It_Messages; +interface Ai_Cf_Google_Gemma_3_12B_It_Prompt { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + /** + * JSON schema that should be fufilled for the response. + */ + guided_json?: object; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Google_Gemma_3_12B_It_Messages { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role?: string; + content?: string | { + /** + * Type of the content provided + */ + type?: string; + text?: string; + image_url?: { + /** + * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted + */ + url?: string; + }; + }[]; + }[]; + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + /** + * JSON schema that should be fufilled for the response. + */ + guided_json?: object; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +type Ai_Cf_Google_Gemma_3_12B_It_Output = { + /** + * The generated text response from the model + */ + response: string; + /** + * Usage statistics for the inference request + */ + usage?: { + /** + * Total number of tokens in input + */ + prompt_tokens?: number; + /** + * Total number of tokens in output + */ + completion_tokens?: number; + /** + * Total number of input and output tokens + */ + total_tokens?: number; + }; + /** + * An array of tool calls requests made during the response generation + */ + tool_calls?: { + /** + * The arguments passed to be passed to the tool call request + */ + arguments?: object; + /** + * The name of the tool to be called + */ + name?: string; + }[]; +}; +declare abstract class Base_Ai_Cf_Google_Gemma_3_12B_It { + inputs: Ai_Cf_Google_Gemma_3_12B_It_Input; + postProcessedOutputs: Ai_Cf_Google_Gemma_3_12B_It_Output; +} +type Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Input = Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Prompt | Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Messages | Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Async_Batch; +interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Prompt { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + /** + * JSON schema that should be fulfilled for the response. + */ + guided_json?: object; + response_format?: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_JSON_Mode; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_JSON_Mode { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Messages { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role?: string; + /** + * The tool call id. If you don't know what to put here you can fall back to 000000001 + */ + tool_call_id?: string; + content?: string | { + /** + * Type of the content provided + */ + type?: string; + text?: string; + image_url?: { + /** + * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted + */ + url?: string; + }; + }[] | { + /** + * Type of the content provided + */ + type?: string; + text?: string; + image_url?: { + /** + * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted + */ + url?: string; + }; + }; + }[]; + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + response_format?: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_JSON_Mode; + /** + * JSON schema that should be fufilled for the response. + */ + guided_json?: object; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Async_Batch { + requests: (Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Prompt_Inner | Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Messages_Inner)[]; +} +interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Prompt_Inner { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + /** + * JSON schema that should be fulfilled for the response. + */ + guided_json?: object; + response_format?: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_JSON_Mode; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Messages_Inner { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role?: string; + /** + * The tool call id. If you don't know what to put here you can fall back to 000000001 + */ + tool_call_id?: string; + content?: string | { + /** + * Type of the content provided + */ + type?: string; + text?: string; + image_url?: { + /** + * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted + */ + url?: string; + }; + }[] | { + /** + * Type of the content provided + */ + type?: string; + text?: string; + image_url?: { + /** + * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted + */ + url?: string; + }; + }; + }[]; + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + response_format?: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_JSON_Mode; + /** + * JSON schema that should be fufilled for the response. + */ + guided_json?: object; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +type Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Output = { + /** + * The generated text response from the model + */ + response: string; + /** + * Usage statistics for the inference request + */ + usage?: { + /** + * Total number of tokens in input + */ + prompt_tokens?: number; + /** + * Total number of tokens in output + */ + completion_tokens?: number; + /** + * Total number of input and output tokens + */ + total_tokens?: number; + }; + /** + * An array of tool calls requests made during the response generation + */ + tool_calls?: { + /** + * The tool call id. + */ + id?: string; + /** + * Specifies the type of tool (e.g., 'function'). + */ + type?: string; + /** + * Details of the function tool. + */ + function?: { + /** + * The name of the tool to be called + */ + name?: string; + /** + * The arguments passed to be passed to the tool call request + */ + arguments?: object; + }; + }[]; +}; +declare abstract class Base_Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct { + inputs: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Input; + postProcessedOutputs: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Output; +} +type Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Input = Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Prompt | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Messages | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Async_Batch; +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Prompt { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + /** + * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + */ + lora?: string; + response_format?: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Messages { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role: string; + content: string | { + /** + * Type of the content (text) + */ + type?: string; + /** + * Text content + */ + text?: string; + }[]; + }[]; + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + response_format?: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_1; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_1 { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Async_Batch { + requests: (Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Prompt_1 | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Messages_1)[]; +} +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Prompt_1 { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + /** + * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + */ + lora?: string; + response_format?: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_2; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_2 { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Messages_1 { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role: string; + content: string | { + /** + * Type of the content (text) + */ + type?: string; + /** + * Text content + */ + text?: string; + }[]; + }[]; + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + response_format?: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_3; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_3 { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +type Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Output = Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Chat_Completion_Response | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Text_Completion_Response | string | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_AsyncResponse; +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Chat_Completion_Response { + /** + * Unique identifier for the completion + */ + id?: string; + /** + * Object type identifier + */ + object?: "chat.completion"; + /** + * Unix timestamp of when the completion was created + */ + created?: number; + /** + * Model used for the completion + */ + model?: string; + /** + * List of completion choices + */ + choices?: { + /** + * Index of the choice in the list + */ + index?: number; + /** + * The message generated by the model + */ + message?: { + /** + * Role of the message author + */ + role: string; + /** + * The content of the message + */ + content: string; + /** + * Internal reasoning content (if available) + */ + reasoning_content?: string; + /** + * Tool calls made by the assistant + */ + tool_calls?: { + /** + * Unique identifier for the tool call + */ + id: string; + /** + * Type of tool call + */ + type: "function"; + function: { + /** + * Name of the function to call + */ + name: string; + /** + * JSON string of arguments for the function + */ + arguments: string; + }; + }[]; + }; + /** + * Reason why the model stopped generating + */ + finish_reason?: string; + /** + * Stop reason (may be null) + */ + stop_reason?: string | null; + /** + * Log probabilities (if requested) + */ + logprobs?: {} | null; + }[]; + /** + * Usage statistics for the inference request + */ + usage?: { + /** + * Total number of tokens in input + */ + prompt_tokens?: number; + /** + * Total number of tokens in output + */ + completion_tokens?: number; + /** + * Total number of input and output tokens + */ + total_tokens?: number; + }; + /** + * Log probabilities for the prompt (if requested) + */ + prompt_logprobs?: {} | null; +} +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Text_Completion_Response { + /** + * Unique identifier for the completion + */ + id?: string; + /** + * Object type identifier + */ + object?: "text_completion"; + /** + * Unix timestamp of when the completion was created + */ + created?: number; + /** + * Model used for the completion + */ + model?: string; + /** + * List of completion choices + */ + choices?: { + /** + * Index of the choice in the list + */ + index: number; + /** + * The generated text completion + */ + text: string; + /** + * Reason why the model stopped generating + */ + finish_reason: string; + /** + * Stop reason (may be null) + */ + stop_reason?: string | null; + /** + * Log probabilities (if requested) + */ + logprobs?: {} | null; + /** + * Log probabilities for the prompt (if requested) + */ + prompt_logprobs?: {} | null; + }[]; + /** + * Usage statistics for the inference request + */ + usage?: { + /** + * Total number of tokens in input + */ + prompt_tokens?: number; + /** + * Total number of tokens in output + */ + completion_tokens?: number; + /** + * Total number of input and output tokens + */ + total_tokens?: number; + }; +} +interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_AsyncResponse { + /** + * The async request id that can be used to obtain the results. + */ + request_id?: string; +} +declare abstract class Base_Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8 { + inputs: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Input; + postProcessedOutputs: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Output; +} +interface Ai_Cf_Deepgram_Nova_3_Input { + audio: { + body: object; + contentType: string; + }; + /** + * Sets how the model will interpret strings submitted to the custom_topic param. When strict, the model will only return topics submitted using the custom_topic param. When extended, the model will return its own detected topics in addition to those submitted using the custom_topic param. + */ + custom_topic_mode?: "extended" | "strict"; + /** + * Custom topics you want the model to detect within your input audio or text if present Submit up to 100 + */ + custom_topic?: string; + /** + * Sets how the model will interpret intents submitted to the custom_intent param. When strict, the model will only return intents submitted using the custom_intent param. When extended, the model will return its own detected intents in addition those submitted using the custom_intents param + */ + custom_intent_mode?: "extended" | "strict"; + /** + * Custom intents you want the model to detect within your input audio if present + */ + custom_intent?: string; + /** + * Identifies and extracts key entities from content in submitted audio + */ + detect_entities?: boolean; + /** + * Identifies the dominant language spoken in submitted audio + */ + detect_language?: boolean; + /** + * Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0 + */ + diarize?: boolean; + /** + * Identify and extract key entities from content in submitted audio + */ + dictation?: boolean; + /** + * Specify the expected encoding of your submitted audio + */ + encoding?: "linear16" | "flac" | "mulaw" | "amr-nb" | "amr-wb" | "opus" | "speex" | "g729"; + /** + * Arbitrary key-value pairs that are attached to the API response for usage in downstream processing + */ + extra?: string; + /** + * Filler Words can help transcribe interruptions in your audio, like 'uh' and 'um' + */ + filler_words?: boolean; + /** + * Key term prompting can boost or suppress specialized terminology and brands. + */ + keyterm?: string; + /** + * Keywords can boost or suppress specialized terminology and brands. + */ + keywords?: string; + /** + * The BCP-47 language tag that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available. + */ + language?: string; + /** + * Spoken measurements will be converted to their corresponding abbreviations. + */ + measurements?: boolean; + /** + * Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip. + */ + mip_opt_out?: boolean; + /** + * Mode of operation for the model representing broad area of topic that will be talked about in the supplied audio + */ + mode?: "general" | "medical" | "finance"; + /** + * Transcribe each audio channel independently. + */ + multichannel?: boolean; + /** + * Numerals converts numbers from written format to numerical format. + */ + numerals?: boolean; + /** + * Splits audio into paragraphs to improve transcript readability. + */ + paragraphs?: boolean; + /** + * Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely. + */ + profanity_filter?: boolean; + /** + * Add punctuation and capitalization to the transcript. + */ + punctuate?: boolean; + /** + * Redaction removes sensitive information from your transcripts. + */ + redact?: string; + /** + * Search for terms or phrases in submitted audio and replaces them. + */ + replace?: string; + /** + * Search for terms or phrases in submitted audio. + */ + search?: string; + /** + * Recognizes the sentiment throughout a transcript or text. + */ + sentiment?: boolean; + /** + * Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability. + */ + smart_format?: boolean; + /** + * Detect topics throughout a transcript or text. + */ + topics?: boolean; + /** + * Segments speech into meaningful semantic units. + */ + utterances?: boolean; + /** + * Seconds to wait before detecting a pause between words in submitted audio. + */ + utt_split?: number; + /** + * The number of channels in the submitted audio + */ + channels?: number; + /** + * Specifies whether the streaming endpoint should provide ongoing transcription updates as more audio is received. When set to true, the endpoint sends continuous updates, meaning transcription results may evolve over time. Note: Supported only for webosockets. + */ + interim_results?: boolean; + /** + * Indicates how long model will wait to detect whether a speaker has finished speaking or pauses for a significant period of time. When set to a value, the streaming endpoint immediately finalizes the transcription for the processed time range and returns the transcript with a speech_final parameter set to true. Can also be set to false to disable endpointing + */ + endpointing?: string; + /** + * Indicates that speech has started. You'll begin receiving Speech Started messages upon speech starting. Note: Supported only for webosockets. + */ + vad_events?: boolean; + /** + * Indicates how long model will wait to send an UtteranceEnd message after a word has been transcribed. Use with interim_results. Note: Supported only for webosockets. + */ + utterance_end_ms?: boolean; +} +interface Ai_Cf_Deepgram_Nova_3_Output { + results?: { + channels?: { + alternatives?: { + confidence?: number; + transcript?: string; + words?: { + confidence?: number; + end?: number; + start?: number; + word?: string; + }[]; + }[]; + }[]; + summary?: { + result?: string; + short?: string; + }; + sentiments?: { + segments?: { + text?: string; + start_word?: number; + end_word?: number; + sentiment?: string; + sentiment_score?: number; + }[]; + average?: { + sentiment?: string; + sentiment_score?: number; + }; + }; + }; +} +declare abstract class Base_Ai_Cf_Deepgram_Nova_3 { + inputs: Ai_Cf_Deepgram_Nova_3_Input; + postProcessedOutputs: Ai_Cf_Deepgram_Nova_3_Output; +} +interface Ai_Cf_Qwen_Qwen3_Embedding_0_6B_Input { + queries?: string | string[]; + /** + * Optional instruction for the task + */ + instruction?: string; + documents?: string | string[]; + text?: string | string[]; +} +interface Ai_Cf_Qwen_Qwen3_Embedding_0_6B_Output { + data?: number[][]; + shape?: number[]; +} +declare abstract class Base_Ai_Cf_Qwen_Qwen3_Embedding_0_6B { + inputs: Ai_Cf_Qwen_Qwen3_Embedding_0_6B_Input; + postProcessedOutputs: Ai_Cf_Qwen_Qwen3_Embedding_0_6B_Output; +} +type Ai_Cf_Pipecat_Ai_Smart_Turn_V2_Input = { + /** + * readable stream with audio data and content-type specified for that data + */ + audio: { + body: object; + contentType: string; + }; + /** + * type of data PCM data that's sent to the inference server as raw array + */ + dtype?: "uint8" | "float32" | "float64"; +} | { + /** + * base64 encoded audio data + */ + audio: string; + /** + * type of data PCM data that's sent to the inference server as raw array + */ + dtype?: "uint8" | "float32" | "float64"; +}; +interface Ai_Cf_Pipecat_Ai_Smart_Turn_V2_Output { + /** + * if true, end-of-turn was detected + */ + is_complete?: boolean; + /** + * probability of the end-of-turn detection + */ + probability?: number; +} +declare abstract class Base_Ai_Cf_Pipecat_Ai_Smart_Turn_V2 { + inputs: Ai_Cf_Pipecat_Ai_Smart_Turn_V2_Input; + postProcessedOutputs: Ai_Cf_Pipecat_Ai_Smart_Turn_V2_Output; +} +declare abstract class Base_Ai_Cf_Openai_Gpt_Oss_120B { + inputs: XOR; + postProcessedOutputs: XOR; +} +declare abstract class Base_Ai_Cf_Openai_Gpt_Oss_20B { + inputs: XOR; + postProcessedOutputs: XOR; +} +interface Ai_Cf_Leonardo_Phoenix_1_0_Input { + /** + * A text description of the image you want to generate. + */ + prompt: string; + /** + * Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt + */ + guidance?: number; + /** + * Random seed for reproducibility of the image generation + */ + seed?: number; + /** + * The height of the generated image in pixels + */ + height?: number; + /** + * The width of the generated image in pixels + */ + width?: number; + /** + * The number of diffusion steps; higher values can improve quality but take longer + */ + num_steps?: number; + /** + * Specify what to exclude from the generated images + */ + negative_prompt?: string; +} +/** + * The generated image in JPEG format + */ +type Ai_Cf_Leonardo_Phoenix_1_0_Output = string; +declare abstract class Base_Ai_Cf_Leonardo_Phoenix_1_0 { + inputs: Ai_Cf_Leonardo_Phoenix_1_0_Input; + postProcessedOutputs: Ai_Cf_Leonardo_Phoenix_1_0_Output; +} +interface Ai_Cf_Leonardo_Lucid_Origin_Input { + /** + * A text description of the image you want to generate. + */ + prompt: string; + /** + * Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt + */ + guidance?: number; + /** + * Random seed for reproducibility of the image generation + */ + seed?: number; + /** + * The height of the generated image in pixels + */ + height?: number; + /** + * The width of the generated image in pixels + */ + width?: number; + /** + * The number of diffusion steps; higher values can improve quality but take longer + */ + num_steps?: number; + /** + * The number of diffusion steps; higher values can improve quality but take longer + */ + steps?: number; +} +interface Ai_Cf_Leonardo_Lucid_Origin_Output { + /** + * The generated image in Base64 format. + */ + image?: string; +} +declare abstract class Base_Ai_Cf_Leonardo_Lucid_Origin { + inputs: Ai_Cf_Leonardo_Lucid_Origin_Input; + postProcessedOutputs: Ai_Cf_Leonardo_Lucid_Origin_Output; +} +interface Ai_Cf_Deepgram_Aura_1_Input { + /** + * Speaker used to produce the audio. + */ + speaker?: "angus" | "asteria" | "arcas" | "orion" | "orpheus" | "athena" | "luna" | "zeus" | "perseus" | "helios" | "hera" | "stella"; + /** + * Encoding of the output audio. + */ + encoding?: "linear16" | "flac" | "mulaw" | "alaw" | "mp3" | "opus" | "aac"; + /** + * Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. + */ + container?: "none" | "wav" | "ogg"; + /** + * The text content to be converted to speech + */ + text: string; + /** + * Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable + */ + sample_rate?: number; + /** + * The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. + */ + bit_rate?: number; +} +/** + * The generated audio in MP3 format + */ +type Ai_Cf_Deepgram_Aura_1_Output = string; +declare abstract class Base_Ai_Cf_Deepgram_Aura_1 { + inputs: Ai_Cf_Deepgram_Aura_1_Input; + postProcessedOutputs: Ai_Cf_Deepgram_Aura_1_Output; +} +interface Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B_Input { + /** + * Input text to translate. Can be a single string or a list of strings. + */ + text: string | string[]; + /** + * Target langauge to translate to + */ + target_language: "asm_Beng" | "awa_Deva" | "ben_Beng" | "bho_Deva" | "brx_Deva" | "doi_Deva" | "eng_Latn" | "gom_Deva" | "gon_Deva" | "guj_Gujr" | "hin_Deva" | "hne_Deva" | "kan_Knda" | "kas_Arab" | "kas_Deva" | "kha_Latn" | "lus_Latn" | "mag_Deva" | "mai_Deva" | "mal_Mlym" | "mar_Deva" | "mni_Beng" | "mni_Mtei" | "npi_Deva" | "ory_Orya" | "pan_Guru" | "san_Deva" | "sat_Olck" | "snd_Arab" | "snd_Deva" | "tam_Taml" | "tel_Telu" | "urd_Arab" | "unr_Deva"; +} +interface Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B_Output { + /** + * Translated texts + */ + translations: string[]; +} +declare abstract class Base_Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B { + inputs: Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B_Input; + postProcessedOutputs: Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B_Output; +} +type Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Input = Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Prompt | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Messages | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Async_Batch; +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Prompt { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + /** + * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + */ + lora?: string; + response_format?: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Messages { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role: string; + content: string | { + /** + * Type of the content (text) + */ + type?: string; + /** + * Text content + */ + text?: string; + }[]; + }[]; + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + response_format?: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_1; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_1 { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Async_Batch { + requests: (Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Prompt_1 | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Messages_1)[]; +} +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Prompt_1 { + /** + * The input text prompt for the model to generate a response. + */ + prompt: string; + /** + * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + */ + lora?: string; + response_format?: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_2; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_2 { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Messages_1 { + /** + * An array of message objects representing the conversation history. + */ + messages: { + /** + * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + */ + role: string; + content: string | { + /** + * Type of the content (text) + */ + type?: string; + /** + * Text content + */ + text?: string; + }[]; + }[]; + functions?: { + name: string; + code: string; + }[]; + /** + * A list of tools available for the assistant to use. + */ + tools?: ({ + /** + * The name of the tool. More descriptive the better. + */ + name: string; + /** + * A brief description of what the tool does. + */ + description: string; + /** + * Schema defining the parameters accepted by the tool. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + } | { + /** + * Specifies the type of tool (e.g., 'function'). + */ + type: string; + /** + * Details of the function tool. + */ + function: { + /** + * The name of the function. + */ + name: string; + /** + * A brief description of what the function does. + */ + description: string; + /** + * Schema defining the parameters accepted by the function. + */ + parameters: { + /** + * The type of the parameters object (usually 'object'). + */ + type: string; + /** + * List of required parameter names. + */ + required?: string[]; + /** + * Definitions of each parameter. + */ + properties: { + [k: string]: { + /** + * The data type of the parameter. + */ + type: string; + /** + * A description of the expected parameter. + */ + description: string; + }; + }; + }; + }; + })[]; + response_format?: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_3; + /** + * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + */ + raw?: boolean; + /** + * If true, the response will be streamed back incrementally using SSE, Server Sent Events. + */ + stream?: boolean; + /** + * The maximum number of tokens to generate in the response. + */ + max_tokens?: number; + /** + * Controls the randomness of the output; higher values produce more random results. + */ + temperature?: number; + /** + * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + */ + top_p?: number; + /** + * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + */ + top_k?: number; + /** + * Random seed for reproducibility of the generation. + */ + seed?: number; + /** + * Penalty for repeated tokens; higher values discourage repetition. + */ + repetition_penalty?: number; + /** + * Decreases the likelihood of the model repeating the same lines verbatim. + */ + frequency_penalty?: number; + /** + * Increases the likelihood of the model introducing new topics. + */ + presence_penalty?: number; +} +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_3 { + type?: "json_object" | "json_schema"; + json_schema?: unknown; +} +type Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Output = Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Chat_Completion_Response | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Text_Completion_Response | string | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_AsyncResponse; +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Chat_Completion_Response { + /** + * Unique identifier for the completion + */ + id?: string; + /** + * Object type identifier + */ + object?: "chat.completion"; + /** + * Unix timestamp of when the completion was created + */ + created?: number; + /** + * Model used for the completion + */ + model?: string; + /** + * List of completion choices + */ + choices?: { + /** + * Index of the choice in the list + */ + index?: number; + /** + * The message generated by the model + */ + message?: { + /** + * Role of the message author + */ + role: string; + /** + * The content of the message + */ + content: string; + /** + * Internal reasoning content (if available) + */ + reasoning_content?: string; + /** + * Tool calls made by the assistant + */ + tool_calls?: { + /** + * Unique identifier for the tool call + */ + id: string; + /** + * Type of tool call + */ + type: "function"; + function: { + /** + * Name of the function to call + */ + name: string; + /** + * JSON string of arguments for the function + */ + arguments: string; + }; + }[]; + }; + /** + * Reason why the model stopped generating + */ + finish_reason?: string; + /** + * Stop reason (may be null) + */ + stop_reason?: string | null; + /** + * Log probabilities (if requested) + */ + logprobs?: {} | null; + }[]; + /** + * Usage statistics for the inference request + */ + usage?: { + /** + * Total number of tokens in input + */ + prompt_tokens?: number; + /** + * Total number of tokens in output + */ + completion_tokens?: number; + /** + * Total number of input and output tokens + */ + total_tokens?: number; + }; + /** + * Log probabilities for the prompt (if requested) + */ + prompt_logprobs?: {} | null; +} +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Text_Completion_Response { + /** + * Unique identifier for the completion + */ + id?: string; + /** + * Object type identifier + */ + object?: "text_completion"; + /** + * Unix timestamp of when the completion was created + */ + created?: number; + /** + * Model used for the completion + */ + model?: string; + /** + * List of completion choices + */ + choices?: { + /** + * Index of the choice in the list + */ + index: number; + /** + * The generated text completion + */ + text: string; + /** + * Reason why the model stopped generating + */ + finish_reason: string; + /** + * Stop reason (may be null) + */ + stop_reason?: string | null; + /** + * Log probabilities (if requested) + */ + logprobs?: {} | null; + /** + * Log probabilities for the prompt (if requested) + */ + prompt_logprobs?: {} | null; + }[]; + /** + * Usage statistics for the inference request + */ + usage?: { + /** + * Total number of tokens in input + */ + prompt_tokens?: number; + /** + * Total number of tokens in output + */ + completion_tokens?: number; + /** + * Total number of input and output tokens + */ + total_tokens?: number; + }; +} +interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_AsyncResponse { + /** + * The async request id that can be used to obtain the results. + */ + request_id?: string; +} +declare abstract class Base_Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It { + inputs: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Input; + postProcessedOutputs: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Output; +} +interface Ai_Cf_Pfnet_Plamo_Embedding_1B_Input { + /** + * Input text to embed. Can be a single string or a list of strings. + */ + text: string | string[]; +} +interface Ai_Cf_Pfnet_Plamo_Embedding_1B_Output { + /** + * Embedding vectors, where each vector is a list of floats. + */ + data: number[][]; + /** + * Shape of the embedding data as [number_of_embeddings, embedding_dimension]. + * + * @minItems 2 + * @maxItems 2 + */ + shape: [ + number, + number + ]; +} +declare abstract class Base_Ai_Cf_Pfnet_Plamo_Embedding_1B { + inputs: Ai_Cf_Pfnet_Plamo_Embedding_1B_Input; + postProcessedOutputs: Ai_Cf_Pfnet_Plamo_Embedding_1B_Output; +} +interface Ai_Cf_Deepgram_Flux_Input { + /** + * Encoding of the audio stream. Currently only supports raw signed little-endian 16-bit PCM. + */ + encoding: "linear16"; + /** + * Sample rate of the audio stream in Hz. + */ + sample_rate: string; + /** + * End-of-turn confidence required to fire an eager end-of-turn event. When set, enables EagerEndOfTurn and TurnResumed events. Valid Values 0.3 - 0.9. + */ + eager_eot_threshold?: string; + /** + * End-of-turn confidence required to finish a turn. Valid Values 0.5 - 0.9. + */ + eot_threshold?: string; + /** + * A turn will be finished when this much time has passed after speech, regardless of EOT confidence. + */ + eot_timeout_ms?: string; + /** + * Keyterm prompting can improve recognition of specialized terminology. Pass multiple keyterm query parameters to boost multiple keyterms. + */ + keyterm?: string; + /** + * Opts out requests from the Deepgram Model Improvement Program. Refer to Deepgram Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip + */ + mip_opt_out?: "true" | "false"; + /** + * Label your requests for the purpose of identification during usage reporting + */ + tag?: string; +} +/** + * Output will be returned as websocket messages. + */ +interface Ai_Cf_Deepgram_Flux_Output { + /** + * The unique identifier of the request (uuid) + */ + request_id?: string; + /** + * Starts at 0 and increments for each message the server sends to the client. + */ + sequence_id?: number; + /** + * The type of event being reported. + */ + event?: "Update" | "StartOfTurn" | "EagerEndOfTurn" | "TurnResumed" | "EndOfTurn"; + /** + * The index of the current turn + */ + turn_index?: number; + /** + * Start time in seconds of the audio range that was transcribed + */ + audio_window_start?: number; + /** + * End time in seconds of the audio range that was transcribed + */ + audio_window_end?: number; + /** + * Text that was said over the course of the current turn + */ + transcript?: string; + /** + * The words in the transcript + */ + words?: { + /** + * The individual punctuated, properly-cased word from the transcript + */ + word: string; + /** + * Confidence that this word was transcribed correctly + */ + confidence: number; + }[]; + /** + * Confidence that no more speech is coming in this turn + */ + end_of_turn_confidence?: number; +} +declare abstract class Base_Ai_Cf_Deepgram_Flux { + inputs: Ai_Cf_Deepgram_Flux_Input; + postProcessedOutputs: Ai_Cf_Deepgram_Flux_Output; +} +interface Ai_Cf_Deepgram_Aura_2_En_Input { + /** + * Speaker used to produce the audio. + */ + speaker?: "amalthea" | "andromeda" | "apollo" | "arcas" | "aries" | "asteria" | "athena" | "atlas" | "aurora" | "callista" | "cora" | "cordelia" | "delia" | "draco" | "electra" | "harmonia" | "helena" | "hera" | "hermes" | "hyperion" | "iris" | "janus" | "juno" | "jupiter" | "luna" | "mars" | "minerva" | "neptune" | "odysseus" | "ophelia" | "orion" | "orpheus" | "pandora" | "phoebe" | "pluto" | "saturn" | "thalia" | "theia" | "vesta" | "zeus"; + /** + * Encoding of the output audio. + */ + encoding?: "linear16" | "flac" | "mulaw" | "alaw" | "mp3" | "opus" | "aac"; + /** + * Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. + */ + container?: "none" | "wav" | "ogg"; + /** + * The text content to be converted to speech + */ + text: string; + /** + * Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable + */ + sample_rate?: number; + /** + * The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. + */ + bit_rate?: number; +} +/** + * The generated audio in MP3 format + */ +type Ai_Cf_Deepgram_Aura_2_En_Output = string; +declare abstract class Base_Ai_Cf_Deepgram_Aura_2_En { + inputs: Ai_Cf_Deepgram_Aura_2_En_Input; + postProcessedOutputs: Ai_Cf_Deepgram_Aura_2_En_Output; +} +interface Ai_Cf_Deepgram_Aura_2_Es_Input { + /** + * Speaker used to produce the audio. + */ + speaker?: "sirio" | "nestor" | "carina" | "celeste" | "alvaro" | "diana" | "aquila" | "selena" | "estrella" | "javier"; + /** + * Encoding of the output audio. + */ + encoding?: "linear16" | "flac" | "mulaw" | "alaw" | "mp3" | "opus" | "aac"; + /** + * Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. + */ + container?: "none" | "wav" | "ogg"; + /** + * The text content to be converted to speech + */ + text: string; + /** + * Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable + */ + sample_rate?: number; + /** + * The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. + */ + bit_rate?: number; +} +/** + * The generated audio in MP3 format + */ +type Ai_Cf_Deepgram_Aura_2_Es_Output = string; +declare abstract class Base_Ai_Cf_Deepgram_Aura_2_Es { + inputs: Ai_Cf_Deepgram_Aura_2_Es_Input; + postProcessedOutputs: Ai_Cf_Deepgram_Aura_2_Es_Output; +} +interface Ai_Cf_Black_Forest_Labs_Flux_2_Dev_Input { + multipart: { + body?: object; + contentType?: string; + }; +} +interface Ai_Cf_Black_Forest_Labs_Flux_2_Dev_Output { + /** + * Generated image as Base64 string. + */ + image?: string; +} +declare abstract class Base_Ai_Cf_Black_Forest_Labs_Flux_2_Dev { + inputs: Ai_Cf_Black_Forest_Labs_Flux_2_Dev_Input; + postProcessedOutputs: Ai_Cf_Black_Forest_Labs_Flux_2_Dev_Output; +} +interface Ai_Cf_Black_Forest_Labs_Flux_2_Klein_4B_Input { + multipart: { + body?: object; + contentType?: string; + }; +} +interface Ai_Cf_Black_Forest_Labs_Flux_2_Klein_4B_Output { + /** + * Generated image as Base64 string. + */ + image?: string; +} +declare abstract class Base_Ai_Cf_Black_Forest_Labs_Flux_2_Klein_4B { + inputs: Ai_Cf_Black_Forest_Labs_Flux_2_Klein_4B_Input; + postProcessedOutputs: Ai_Cf_Black_Forest_Labs_Flux_2_Klein_4B_Output; +} +interface Ai_Cf_Black_Forest_Labs_Flux_2_Klein_9B_Input { + multipart: { + body?: object; + contentType?: string; + }; +} +interface Ai_Cf_Black_Forest_Labs_Flux_2_Klein_9B_Output { + /** + * Generated image as Base64 string. + */ + image?: string; +} +declare abstract class Base_Ai_Cf_Black_Forest_Labs_Flux_2_Klein_9B { + inputs: Ai_Cf_Black_Forest_Labs_Flux_2_Klein_9B_Input; + postProcessedOutputs: Ai_Cf_Black_Forest_Labs_Flux_2_Klein_9B_Output; +} +declare abstract class Base_Ai_Cf_Zai_Org_Glm_4_7_Flash { + inputs: ChatCompletionsInput; + postProcessedOutputs: ChatCompletionsOutput; +} +declare abstract class Base_Ai_Cf_Moonshotai_Kimi_K2_5 { + inputs: ChatCompletionsInput; + postProcessedOutputs: ChatCompletionsOutput; +} +declare abstract class Base_Ai_Cf_Nvidia_Nemotron_3_120B_A12B { + inputs: ChatCompletionsInput; + postProcessedOutputs: ChatCompletionsOutput; +} +declare abstract class Base_Ai_Cf_Google_Gemma_4_26B_A4B_IT { + inputs: ChatCompletionsInput; + postProcessedOutputs: ChatCompletionsOutput; +} +interface AiModels { + "@cf/huggingface/distilbert-sst-2-int8": BaseAiTextClassification; + "@cf/stabilityai/stable-diffusion-xl-base-1.0": BaseAiTextToImage; + "@cf/runwayml/stable-diffusion-v1-5-inpainting": BaseAiTextToImage; + "@cf/runwayml/stable-diffusion-v1-5-img2img": BaseAiTextToImage; + "@cf/lykon/dreamshaper-8-lcm": BaseAiTextToImage; + "@cf/bytedance/stable-diffusion-xl-lightning": BaseAiTextToImage; + "@cf/myshell-ai/melotts": BaseAiTextToSpeech; + "@cf/google/embeddinggemma-300m": BaseAiTextEmbeddings; + "@cf/microsoft/resnet-50": BaseAiImageClassification; + "@cf/meta/llama-2-7b-chat-int8": BaseAiTextGeneration; + "@cf/mistral/mistral-7b-instruct-v0.1": BaseAiTextGeneration; + "@cf/meta/llama-2-7b-chat-fp16": BaseAiTextGeneration; + "@hf/thebloke/llama-2-13b-chat-awq": BaseAiTextGeneration; + "@hf/thebloke/mistral-7b-instruct-v0.1-awq": BaseAiTextGeneration; + "@hf/thebloke/zephyr-7b-beta-awq": BaseAiTextGeneration; + "@hf/thebloke/openhermes-2.5-mistral-7b-awq": BaseAiTextGeneration; + "@hf/thebloke/neural-chat-7b-v3-1-awq": BaseAiTextGeneration; + "@hf/thebloke/deepseek-coder-6.7b-base-awq": BaseAiTextGeneration; + "@hf/thebloke/deepseek-coder-6.7b-instruct-awq": BaseAiTextGeneration; + "@cf/deepseek-ai/deepseek-math-7b-instruct": BaseAiTextGeneration; + "@cf/defog/sqlcoder-7b-2": BaseAiTextGeneration; + "@cf/openchat/openchat-3.5-0106": BaseAiTextGeneration; + "@cf/tiiuae/falcon-7b-instruct": BaseAiTextGeneration; + "@cf/thebloke/discolm-german-7b-v1-awq": BaseAiTextGeneration; + "@cf/qwen/qwen1.5-0.5b-chat": BaseAiTextGeneration; + "@cf/qwen/qwen1.5-7b-chat-awq": BaseAiTextGeneration; + "@cf/qwen/qwen1.5-14b-chat-awq": BaseAiTextGeneration; + "@cf/tinyllama/tinyllama-1.1b-chat-v1.0": BaseAiTextGeneration; + "@cf/microsoft/phi-2": BaseAiTextGeneration; + "@cf/qwen/qwen1.5-1.8b-chat": BaseAiTextGeneration; + "@cf/mistral/mistral-7b-instruct-v0.2-lora": BaseAiTextGeneration; + "@hf/nousresearch/hermes-2-pro-mistral-7b": BaseAiTextGeneration; + "@hf/nexusflow/starling-lm-7b-beta": BaseAiTextGeneration; + "@hf/google/gemma-7b-it": BaseAiTextGeneration; + "@cf/meta-llama/llama-2-7b-chat-hf-lora": BaseAiTextGeneration; + "@cf/google/gemma-2b-it-lora": BaseAiTextGeneration; + "@cf/google/gemma-7b-it-lora": BaseAiTextGeneration; + "@hf/mistral/mistral-7b-instruct-v0.2": BaseAiTextGeneration; + "@cf/meta/llama-3-8b-instruct": BaseAiTextGeneration; + "@cf/fblgit/una-cybertron-7b-v2-bf16": BaseAiTextGeneration; + "@cf/meta/llama-3-8b-instruct-awq": BaseAiTextGeneration; + "@cf/meta/llama-3.1-8b-instruct-fp8": BaseAiTextGeneration; + "@cf/meta/llama-3.1-8b-instruct-awq": BaseAiTextGeneration; + "@cf/meta/llama-3.2-3b-instruct": BaseAiTextGeneration; + "@cf/meta/llama-3.2-1b-instruct": BaseAiTextGeneration; + "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b": BaseAiTextGeneration; + "@cf/ibm-granite/granite-4.0-h-micro": BaseAiTextGeneration; + "@cf/facebook/bart-large-cnn": BaseAiSummarization; + "@cf/llava-hf/llava-1.5-7b-hf": BaseAiImageToText; + "@cf/baai/bge-base-en-v1.5": Base_Ai_Cf_Baai_Bge_Base_En_V1_5; + "@cf/openai/whisper": Base_Ai_Cf_Openai_Whisper; + "@cf/meta/m2m100-1.2b": Base_Ai_Cf_Meta_M2M100_1_2B; + "@cf/baai/bge-small-en-v1.5": Base_Ai_Cf_Baai_Bge_Small_En_V1_5; + "@cf/baai/bge-large-en-v1.5": Base_Ai_Cf_Baai_Bge_Large_En_V1_5; + "@cf/unum/uform-gen2-qwen-500m": Base_Ai_Cf_Unum_Uform_Gen2_Qwen_500M; + "@cf/openai/whisper-tiny-en": Base_Ai_Cf_Openai_Whisper_Tiny_En; + "@cf/openai/whisper-large-v3-turbo": Base_Ai_Cf_Openai_Whisper_Large_V3_Turbo; + "@cf/baai/bge-m3": Base_Ai_Cf_Baai_Bge_M3; + "@cf/black-forest-labs/flux-1-schnell": Base_Ai_Cf_Black_Forest_Labs_Flux_1_Schnell; + "@cf/meta/llama-3.2-11b-vision-instruct": Base_Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct; + "@cf/meta/llama-3.3-70b-instruct-fp8-fast": Base_Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast; + "@cf/meta/llama-guard-3-8b": Base_Ai_Cf_Meta_Llama_Guard_3_8B; + "@cf/baai/bge-reranker-base": Base_Ai_Cf_Baai_Bge_Reranker_Base; + "@cf/qwen/qwen2.5-coder-32b-instruct": Base_Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct; + "@cf/qwen/qwq-32b": Base_Ai_Cf_Qwen_Qwq_32B; + "@cf/mistralai/mistral-small-3.1-24b-instruct": Base_Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct; + "@cf/google/gemma-3-12b-it": Base_Ai_Cf_Google_Gemma_3_12B_It; + "@cf/meta/llama-4-scout-17b-16e-instruct": Base_Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct; + "@cf/qwen/qwen3-30b-a3b-fp8": Base_Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8; + "@cf/deepgram/nova-3": Base_Ai_Cf_Deepgram_Nova_3; + "@cf/qwen/qwen3-embedding-0.6b": Base_Ai_Cf_Qwen_Qwen3_Embedding_0_6B; + "@cf/pipecat-ai/smart-turn-v2": Base_Ai_Cf_Pipecat_Ai_Smart_Turn_V2; + "@cf/openai/gpt-oss-120b": Base_Ai_Cf_Openai_Gpt_Oss_120B; + "@cf/openai/gpt-oss-20b": Base_Ai_Cf_Openai_Gpt_Oss_20B; + "@cf/leonardo/phoenix-1.0": Base_Ai_Cf_Leonardo_Phoenix_1_0; + "@cf/leonardo/lucid-origin": Base_Ai_Cf_Leonardo_Lucid_Origin; + "@cf/deepgram/aura-1": Base_Ai_Cf_Deepgram_Aura_1; + "@cf/ai4bharat/indictrans2-en-indic-1B": Base_Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B; + "@cf/aisingapore/gemma-sea-lion-v4-27b-it": Base_Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It; + "@cf/pfnet/plamo-embedding-1b": Base_Ai_Cf_Pfnet_Plamo_Embedding_1B; + "@cf/deepgram/flux": Base_Ai_Cf_Deepgram_Flux; + "@cf/deepgram/aura-2-en": Base_Ai_Cf_Deepgram_Aura_2_En; + "@cf/deepgram/aura-2-es": Base_Ai_Cf_Deepgram_Aura_2_Es; + "@cf/black-forest-labs/flux-2-dev": Base_Ai_Cf_Black_Forest_Labs_Flux_2_Dev; + "@cf/black-forest-labs/flux-2-klein-4b": Base_Ai_Cf_Black_Forest_Labs_Flux_2_Klein_4B; + "@cf/black-forest-labs/flux-2-klein-9b": Base_Ai_Cf_Black_Forest_Labs_Flux_2_Klein_9B; + "@cf/zai-org/glm-4.7-flash": Base_Ai_Cf_Zai_Org_Glm_4_7_Flash; + "@cf/moonshotai/kimi-k2.5": Base_Ai_Cf_Moonshotai_Kimi_K2_5; + "@cf/nvidia/nemotron-3-120b-a12b": Base_Ai_Cf_Nvidia_Nemotron_3_120B_A12B; +} +type AiOptions = { + /** + * Send requests as an asynchronous batch job, only works for supported models + * https://developers.cloudflare.com/workers-ai/features/batch-api + */ + queueRequest?: boolean; + /** + * Establish websocket connections, only works for supported models + */ + websocket?: boolean; + /** + * Tag your requests to group and view them in Cloudflare dashboard. + * + * Rules: + * Tags must only contain letters, numbers, and the symbols: : - . / @ + * Each tag can have maximum 50 characters. + * Maximum 5 tags are allowed each request. + * Duplicate tags will removed. + */ + tags?: string[]; + gateway?: GatewayOptions; + returnRawResponse?: boolean; + prefix?: string; + extraHeaders?: object; + signal?: AbortSignal; +}; +type AiModelsSearchParams = { + author?: string; + hide_experimental?: boolean; + page?: number; + per_page?: number; + search?: string; + source?: number; + task?: string; +}; +type AiModelsSearchObject = { + id: string; + source: number; + name: string; + description: string; + task: { + id: string; + name: string; + description: string; + }; + tags: string[]; + properties: { + property_id: string; + value: string; + }[]; +}; +type ChatCompletionsBase = XOR; +type ChatCompletionsInput = XOR; +interface InferenceUpstreamError extends Error { +} +interface AiInternalError extends Error { +} +type AiModelListType = Record; +type AiAsyncBatchResponse = { + request_id: string; +}; +declare abstract class Ai { + aiGatewayLogId: string | null; + gateway(gatewayId: string): AiGateway; + /** + * @deprecated Use the standalone `ai_search_namespaces` or `ai_search` Workers bindings instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ + aiSearch(): AiSearchNamespace; + /** + * @deprecated AutoRAG has been replaced by AI Search. + * Use the standalone `ai_search_namespaces` or `ai_search` Workers bindings instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + * + * @param autoragId Instance ID + */ + autorag(autoragId: string): AutoRAG; + // Batch request + run(model: Name, inputs: { + requests: AiModelList[Name]['inputs'][]; + }, options: AiOptions & { + queueRequest: true; + }): Promise; + // Raw response + run(model: Name, inputs: AiModelList[Name]['inputs'], options: AiOptions & { + returnRawResponse: true; + }): Promise; + // WebSocket + run(model: Name, inputs: AiModelList[Name]['inputs'], options: AiOptions & { + websocket: true; + }): Promise; + // Streaming + run(model: Name, inputs: AiModelList[Name]['inputs'] & { + stream: true; + }, options?: AiOptions): Promise; + // Normal (default) - known model + run(model: Name, inputs: AiModelList[Name]['inputs'], options?: AiOptions): Promise; + // Unknown model (gateway fallback) + run(model: string & {}, inputs: Record, options?: AiOptions): Promise>; + models(params?: AiModelsSearchParams): Promise; + toMarkdown(): ToMarkdownService; + toMarkdown(files: MarkdownDocument[], options?: ConversionRequestOptions): Promise; + toMarkdown(files: MarkdownDocument, options?: ConversionRequestOptions): Promise; +} +type GatewayRetries = { + maxAttempts?: 1 | 2 | 3 | 4 | 5; + retryDelayMs?: number; + backoff?: 'constant' | 'linear' | 'exponential'; +}; +type GatewayOptions = { + id: string; + cacheKey?: string; + cacheTtl?: number; + skipCache?: boolean; + metadata?: Record; + collectLog?: boolean; + eventId?: string; + requestTimeoutMs?: number; + retries?: GatewayRetries; +}; +type UniversalGatewayOptions = Exclude & { + /** + ** @deprecated + */ + id?: string; +}; +type AiGatewayPatchLog = { + score?: number | null; + feedback?: -1 | 1 | null; + metadata?: Record | null; +}; +type AiGatewayLog = { + id: string; + provider: string; + model: string; + model_type?: string; + path: string; + duration: number; + request_type?: string; + request_content_type?: string; + status_code: number; + response_content_type?: string; + success: boolean; + cached: boolean; + tokens_in?: number; + tokens_out?: number; + metadata?: Record; + step?: number; + cost?: number; + custom_cost?: boolean; + request_size: number; + request_head?: string; + request_head_complete: boolean; + response_size: number; + response_head?: string; + response_head_complete: boolean; + created_at: Date; +}; +type AIGatewayProviders = 'workers-ai' | 'anthropic' | 'aws-bedrock' | 'azure-openai' | 'google-vertex-ai' | 'huggingface' | 'openai' | 'perplexity-ai' | 'replicate' | 'groq' | 'cohere' | 'google-ai-studio' | 'mistral' | 'grok' | 'openrouter' | 'deepseek' | 'cerebras' | 'cartesia' | 'elevenlabs' | 'adobe-firefly'; +type AIGatewayHeaders = { + 'cf-aig-metadata': Record | string; + 'cf-aig-custom-cost': { + per_token_in?: number; + per_token_out?: number; + } | { + total_cost?: number; + } | string; + 'cf-aig-cache-ttl': number | string; + 'cf-aig-skip-cache': boolean | string; + 'cf-aig-cache-key': string; + 'cf-aig-event-id': string; + 'cf-aig-request-timeout': number | string; + 'cf-aig-max-attempts': number | string; + 'cf-aig-retry-delay': number | string; + 'cf-aig-backoff': string; + 'cf-aig-collect-log': boolean | string; + Authorization: string; + 'Content-Type': string; + [key: string]: string | number | boolean | object; +}; +type AIGatewayUniversalRequest = { + provider: AIGatewayProviders | string; // eslint-disable-line + endpoint: string; + headers: Partial; + query: unknown; +}; +interface AiGatewayInternalError extends Error { +} +interface AiGatewayLogNotFound extends Error { +} +declare abstract class AiGateway { + patchLog(logId: string, data: AiGatewayPatchLog): Promise; + getLog(logId: string): Promise; + run(data: AIGatewayUniversalRequest | AIGatewayUniversalRequest[], options?: { + gateway?: UniversalGatewayOptions; + extraHeaders?: object; + signal?: AbortSignal; + }): Promise; + getUrl(provider?: AIGatewayProviders | string): Promise; // eslint-disable-line +} +// Copyright (c) 2022-2025 Cloudflare, Inc. +// Licensed under the Apache 2.0 license found in the LICENSE file or at: +// https://opensource.org/licenses/Apache-2.0 +/** + * Artifacts — Git-compatible file storage on Cloudflare Workers. + * + * Provides programmatic access to create, manage, and fork repositories, + * and to issue and revoke scoped access tokens. + */ +/** Information about a repository. */ +interface ArtifactsRepoInfo { + /** Unique repository ID. */ + id: string; + /** Repository name. */ + name: string; + /** Repository description, or null if not set. */ + description: string | null; + /** Default branch name (e.g. "main"). */ + defaultBranch: string; + /** ISO 8601 creation timestamp. */ + createdAt: string; + /** ISO 8601 last-updated timestamp. */ + updatedAt: string; + /** ISO 8601 timestamp of the last push, or null if never pushed. */ + lastPushAt: string | null; + /** Fork source (e.g. "github:owner/repo", "artifacts:namespace/repo"), or null if not a fork. */ + source: string | null; + /** Whether the repository is read-only. */ + readOnly: boolean; + /** HTTPS git remote URL. */ + remote: string; +} +/** Result of creating a repository — includes the initial access token. */ +interface ArtifactsCreateRepoResult { + /** Unique repository ID. */ + id: string; + /** Repository name. */ + name: string; + /** Repository description, or null if not set. */ + description: string | null; + /** Default branch name. */ + defaultBranch: string; + /** HTTPS git remote URL. */ + remote: string; + /** Plaintext access token (only returned at creation time). */ + token: string; + /** ISO 8601 token expiry timestamp. */ + tokenExpiresAt: string; +} +/** Paginated list of repositories. */ +interface ArtifactsRepoListResult { + /** Repositories in this page (without the `remote` field). */ + repos: Omit[]; + /** Total number of repositories in the namespace. */ + total: number; + /** Cursor for the next page, if there are more results. */ + cursor?: string; +} +/** Result of creating an access token. */ +interface ArtifactsCreateTokenResult { + /** Unique token ID. */ + id: string; + /** Plaintext token (only returned at creation time). */ + plaintext: string; + /** Token scope: "read" or "write". */ + scope: 'read' | 'write'; + /** ISO 8601 token expiry timestamp. */ + expiresAt: string; +} +/** Token metadata (no plaintext). */ +interface ArtifactsTokenInfo { + /** Unique token ID. */ + id: string; + /** Token scope: "read" or "write". */ + scope: 'read' | 'write'; + /** Token state: "active", "expired", or "revoked". */ + state: 'active' | 'expired' | 'revoked'; + /** ISO 8601 creation timestamp. */ + createdAt: string; + /** ISO 8601 expiry timestamp. */ + expiresAt: string; +} +/** Paginated list of tokens for a repository. */ +interface ArtifactsTokenListResult { + /** Tokens in this page. */ + tokens: ArtifactsTokenInfo[]; + /** Total number of tokens for the repository. */ + total: number; +} +/** Handle for a single repository. Returned by Artifacts.get(). */ +interface ArtifactsRepo extends ArtifactsRepoInfo { + /** + * Create an access token for this repo. + * @param scope Token scope: "write" (default) or "read". + * @param ttl Time-to-live in seconds (default 86400, min 60, max 31536000). + */ + createToken(scope?: 'write' | 'read', ttl?: number): Promise; + /** List tokens for this repo (metadata only, no plaintext). */ + listTokens(): Promise; + /** + * Revoke a token by plaintext or ID. + * @param tokenOrId Plaintext token or token ID. + * @returns true if revoked, false if not found. + */ + revokeToken(tokenOrId: string): Promise; + // ── Fork ── + /** + * Fork this repo to a new repo. + * @param name Target repository name. + * @param opts Optional: description, readOnly flag, defaultBranchOnly (default true). + */ + fork(name: string, opts?: { + description?: string; + readOnly?: boolean; + defaultBranchOnly?: boolean; + }): Promise; +} +/** Artifacts binding — namespace-level operations. */ +interface Artifacts { + /** + * Create a new repository with an initial access token. + * @param name Repository name (alphanumeric, dots, hyphens, underscores). + * @param opts Optional: readOnly flag, description, default branch name. + * @returns Repo metadata with initial token. + */ + create(name: string, opts?: { + readOnly?: boolean; + description?: string; + setDefaultBranch?: string; + }): Promise; + /** + * Get a handle to an existing repository. + * @param name Repository name. + * @returns Repo handle. + */ + get(name: string): Promise; + /** + * Import a repository from an external git remote. + * @param params Source URL and optional branch/depth, plus target name and options. + * @returns Repo metadata with initial token. + */ + import(params: { + source: { + url: string; + branch?: string; + depth?: number; + }; + target: { + name: string; + opts?: { + description?: string; + readOnly?: boolean; + }; + }; + }): Promise; + /** + * List repositories with cursor-based pagination. + * @param opts Optional: limit (1–200, default 50), cursor for next page. + */ + list(opts?: { + limit?: number; + cursor?: string; + }): Promise; + /** + * Delete a repository and all associated tokens. + * @param name Repository name. + * @returns true if deleted, false if not found. + */ + delete(name: string): Promise; +} +/** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ +interface AutoRAGInternalError extends Error { +} +/** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ +interface AutoRAGNotFoundError extends Error { +} +/** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ +interface AutoRAGUnauthorizedError extends Error { +} +/** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ +interface AutoRAGNameNotSetError extends Error { +} +type ComparisonFilter = { + key: string; + type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte'; + value: string | number | boolean; +}; +type CompoundFilter = { + type: 'and' | 'or'; + filters: ComparisonFilter[]; +}; +/** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ +type AutoRagSearchRequest = { + query: string; + filters?: CompoundFilter | ComparisonFilter; + max_num_results?: number; + ranking_options?: { + ranker?: string; + score_threshold?: number; + }; + reranking?: { + enabled?: boolean; + model?: string; + }; + rewrite_query?: boolean; +}; +/** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ +type AutoRagAiSearchRequest = AutoRagSearchRequest & { + stream?: boolean; + system_prompt?: string; +}; +/** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ +type AutoRagAiSearchRequestStreaming = Omit & { + stream: true; +}; +/** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ +type AutoRagSearchResponse = { + object: 'vector_store.search_results.page'; + search_query: string; + data: { + file_id: string; + filename: string; + score: number; + attributes: Record; + content: { + type: 'text'; + text: string; + }[]; + }[]; + has_more: boolean; + next_page: string | null; +}; +/** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ +type AutoRagListResponse = { + id: string; + enable: boolean; + type: string; + source: string; + vectorize_name: string; + paused: boolean; + status: string; +}[]; +/** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ +type AutoRagAiSearchResponse = AutoRagSearchResponse & { + response: string; +}; +/** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ +declare abstract class AutoRAG { + /** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ + list(): Promise; + /** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ + search(params: AutoRagSearchRequest): Promise; + /** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ + aiSearch(params: AutoRagAiSearchRequestStreaming): Promise; + /** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ + aiSearch(params: AutoRagAiSearchRequest): Promise; + /** + * @deprecated Use the standalone AI Search Workers binding instead. + * See https://developers.cloudflare.com/ai-search/usage/workers-binding/ + */ + aiSearch(params: AutoRagAiSearchRequest): Promise; +} +interface BasicImageTransformations { + /** + * Maximum width in image pixels. The value must be an integer. + */ + width?: number; + /** + * Maximum height in image pixels. The value must be an integer. + */ + height?: number; + /** + * Resizing mode as a string. It affects interpretation of width and height + * options: + * - scale-down: Similar to contain, but the image is never enlarged. If + * the image is larger than given width or height, it will be resized. + * Otherwise its original size will be kept. + * - contain: Resizes to maximum size that fits within the given width and + * height. If only a single dimension is given (e.g. only width), the + * image will be shrunk or enlarged to exactly match that dimension. + * Aspect ratio is always preserved. + * - cover: Resizes (shrinks or enlarges) to fill the entire area of width + * and height. If the image has an aspect ratio different from the ratio + * of width and height, it will be cropped to fit. + * - crop: The image will be shrunk and cropped to fit within the area + * specified by width and height. The image will not be enlarged. For images + * smaller than the given dimensions it's the same as scale-down. For + * images larger than the given dimensions, it's the same as cover. + * See also trim. + * - pad: Resizes to the maximum size that fits within the given width and + * height, and then fills the remaining area with a background color + * (white by default). Use of this mode is not recommended, as the same + * effect can be more efficiently achieved with the contain mode and the + * CSS object-fit: contain property. + * - squeeze: Stretches and deforms to the width and height given, even if it + * breaks aspect ratio + */ + fit?: "scale-down" | "contain" | "cover" | "crop" | "pad" | "squeeze"; + /** + * Image segmentation using artificial intelligence models. Sets pixels not + * within selected segment area to transparent e.g "foreground" sets every + * background pixel as transparent. + */ + segment?: "foreground"; + /** + * When cropping with fit: "cover", this defines the side or point that should + * be left uncropped. The value is either a string + * "left", "right", "top", "bottom", "auto", or "center" (the default), + * or an object {x, y} containing focal point coordinates in the original + * image expressed as fractions ranging from 0.0 (top or left) to 1.0 + * (bottom or right), 0.5 being the center. {fit: "cover", gravity: "top"} will + * crop bottom or left and right sides as necessary, but won’t crop anything + * from the top. {fit: "cover", gravity: {x:0.5, y:0.2}} will crop each side to + * preserve as much as possible around a point at 20% of the height of the + * source image. + */ + gravity?: 'face' | 'left' | 'right' | 'top' | 'bottom' | 'center' | 'auto' | 'entropy' | BasicImageTransformationsGravityCoordinates; + /** + * Background color to add underneath the image. Applies only to images with + * transparency (such as PNG). Accepts any CSS color (#RRGGBB, rgba(…), + * hsl(…), etc.) + */ + background?: string; + /** + * Number of degrees (90, 180, 270) to rotate the image by. width and height + * options refer to axes after rotation. + */ + rotate?: 0 | 90 | 180 | 270 | 360; +} +interface BasicImageTransformationsGravityCoordinates { + x?: number; + y?: number; + mode?: 'remainder' | 'box-center'; +} +/** + * In addition to the properties you can set in the RequestInit dict + * that you pass as an argument to the Request constructor, you can + * set certain properties of a `cf` object to control how Cloudflare + * features are applied to that new Request. + * + * Note: Currently, these properties cannot be tested in the + * playground. + */ +interface RequestInitCfProperties extends Record { + cacheEverything?: boolean; + /** + * A request's cache key is what determines if two requests are + * "the same" for caching purposes. If a request has the same cache key + * as some previous request, then we can serve the same cached response for + * both. (e.g. 'some-key') + * + * Only available for Enterprise customers. + */ + cacheKey?: string; + /** + * This allows you to append additional Cache-Tag response headers + * to the origin response without modifications to the origin server. + * This will allow for greater control over the Purge by Cache Tag feature + * utilizing changes only in the Workers process. + * + * Only available for Enterprise customers. + */ + cacheTags?: string[]; + /** + * Force response to be cached for a given number of seconds. (e.g. 300) + */ + cacheTtl?: number; + /** + * Force response to be cached for a given number of seconds based on the Origin status code. + * (e.g. { '200-299': 86400, '404': 1, '500-599': 0 }) + */ + cacheTtlByStatus?: Record; + /** + * Explicit Cache-Control header value to set on the response stored in cache. + * This gives full control over cache directives (e.g. 'public, max-age=3600, s-maxage=86400'). + * + * Cannot be used together with `cacheTtl` or the `cache` request option (`no-store`/`no-cache`), + * as these are mutually exclusive cache control mechanisms. Setting both will throw a TypeError. + * + * Can be used together with `cacheTtlByStatus`. + */ + cacheControl?: string; + /** + * Whether the response should be eligible for Cache Reserve storage. + */ + cacheReserveEligible?: boolean; + /** + * Whether to respect strong ETags (as opposed to weak ETags) from the origin. + */ + respectStrongEtag?: boolean; + /** + * Whether to strip ETag headers from the origin response before caching. + */ + stripEtags?: boolean; + /** + * Whether to strip Last-Modified headers from the origin response before caching. + */ + stripLastModified?: boolean; + /** + * Whether to enable Cache Deception Armor, which protects against web cache + * deception attacks by verifying the Content-Type matches the URL extension. + */ + cacheDeceptionArmor?: boolean; + /** + * Minimum file size in bytes for a response to be eligible for Cache Reserve storage. + */ + cacheReserveMinimumFileSize?: number; + scrapeShield?: boolean; + apps?: boolean; + image?: RequestInitCfPropertiesImage; + minify?: RequestInitCfPropertiesImageMinify; + mirage?: boolean; + polish?: "lossy" | "lossless" | "off"; + r2?: RequestInitCfPropertiesR2; + /** + * Redirects the request to an alternate origin server. You can use this, + * for example, to implement load balancing across several origins. + * (e.g.us-east.example.com) + * + * Note - For security reasons, the hostname set in resolveOverride must + * be proxied on the same Cloudflare zone of the incoming request. + * Otherwise, the setting is ignored. CNAME hosts are allowed, so to + * resolve to a host under a different domain or a DNS only domain first + * declare a CNAME record within your own zone’s DNS mapping to the + * external hostname, set proxy on Cloudflare, then set resolveOverride + * to point to that CNAME record. + */ + resolveOverride?: string; +} +interface RequestInitCfPropertiesImageDraw extends BasicImageTransformations { + /** + * Absolute URL of the image file to use for the drawing. It can be any of + * the supported file formats. For drawing of watermarks or non-rectangular + * overlays we recommend using PNG or WebP images. + */ + url: string; + /** + * Floating-point number between 0 (transparent) and 1 (opaque). + * For example, opacity: 0.5 makes overlay semitransparent. + */ + opacity?: number; + /** + * - If set to true, the overlay image will be tiled to cover the entire + * area. This is useful for stock-photo-like watermarks. + * - If set to "x", the overlay image will be tiled horizontally only + * (form a line). + * - If set to "y", the overlay image will be tiled vertically only + * (form a line). + */ + repeat?: true | "x" | "y"; + /** + * Position of the overlay image relative to a given edge. Each property is + * an offset in pixels. 0 aligns exactly to the edge. For example, left: 10 + * positions left side of the overlay 10 pixels from the left edge of the + * image it's drawn over. bottom: 0 aligns bottom of the overlay with bottom + * of the background image. + * + * Setting both left & right, or both top & bottom is an error. + * + * If no position is specified, the image will be centered. + */ + top?: number; + left?: number; + bottom?: number; + right?: number; +} +interface RequestInitCfPropertiesImage extends BasicImageTransformations { + /** + * Device Pixel Ratio. Default 1. Multiplier for width/height that makes it + * easier to specify higher-DPI sizes in . + */ + dpr?: number; + /** + * Allows you to trim your image. Takes dpr into account and is performed before + * resizing or rotation. + * + * It can be used as: + * - left, top, right, bottom - it will specify the number of pixels to cut + * off each side + * - width, height - the width/height you'd like to end up with - can be used + * in combination with the properties above + * - border - this will automatically trim the surroundings of an image based on + * it's color. It consists of three properties: + * - color: rgb or hex representation of the color you wish to trim (todo: verify the rgba bit) + * - tolerance: difference from color to treat as color + * - keep: the number of pixels of border to keep + */ + trim?: "border" | { + top?: number; + bottom?: number; + left?: number; + right?: number; + width?: number; + height?: number; + border?: boolean | { + color?: string; + tolerance?: number; + keep?: number; + }; + }; + /** + * Quality setting from 1-100 (useful values are in 60-90 range). Lower values + * make images look worse, but load faster. The default is 85. It applies only + * to JPEG and WebP images. It doesn’t have any effect on PNG. + */ + quality?: number | "low" | "medium-low" | "medium-high" | "high"; + /** + * Output format to generate. It can be: + * - avif: generate images in AVIF format. + * - webp: generate images in Google WebP format. Set quality to 100 to get + * the WebP-lossless format. + * - json: instead of generating an image, outputs information about the + * image, in JSON format. The JSON object will contain image size + * (before and after resizing), source image’s MIME type, file size, etc. + * - jpeg: generate images in JPEG format. + * - png: generate images in PNG format. + */ + format?: "avif" | "webp" | "json" | "jpeg" | "png" | "baseline-jpeg" | "png-force" | "svg"; + /** + * Whether to preserve animation frames from input files. Default is true. + * Setting it to false reduces animations to still images. This setting is + * recommended when enlarging images or processing arbitrary user content, + * because large GIF animations can weigh tens or even hundreds of megabytes. + * It is also useful to set anim:false when using format:"json" to get the + * response quicker without the number of frames. + */ + anim?: boolean; + /** + * What EXIF data should be preserved in the output image. Note that EXIF + * rotation and embedded color profiles are always applied ("baked in" into + * the image), and aren't affected by this option. Note that if the Polish + * feature is enabled, all metadata may have been removed already and this + * option may have no effect. + * - keep: Preserve most of EXIF metadata, including GPS location if there's + * any. + * - copyright: Only keep the copyright tag, and discard everything else. + * This is the default behavior for JPEG files. + * - none: Discard all invisible EXIF metadata. Currently WebP and PNG + * output formats always discard metadata. + */ + metadata?: "keep" | "copyright" | "none"; + /** + * Strength of sharpening filter to apply to the image. Floating-point + * number between 0 (no sharpening, default) and 10 (maximum). 1.0 is a + * recommended value for downscaled images. + */ + sharpen?: number; + /** + * Radius of a blur filter (approximate gaussian). Maximum supported radius + * is 250. + */ + blur?: number; + /** + * Overlays are drawn in the order they appear in the array (last array + * entry is the topmost layer). + */ + draw?: RequestInitCfPropertiesImageDraw[]; + /** + * Fetching image from authenticated origin. Setting this property will + * pass authentication headers (Authorization, Cookie, etc.) through to + * the origin. + */ + "origin-auth"?: "share-publicly"; + /** + * Adds a border around the image. The border is added after resizing. Border + * width takes dpr into account, and can be specified either using a single + * width property, or individually for each side. + */ + border?: { + color: string; + width: number; + } | { + color: string; + top: number; + right: number; + bottom: number; + left: number; + }; + /** + * Increase brightness by a factor. A value of 1.0 equals no change, a value + * of 0.5 equals half brightness, and a value of 2.0 equals twice as bright. + * 0 is ignored. + */ + brightness?: number; + /** + * Increase contrast by a factor. A value of 1.0 equals no change, a value of + * 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is + * ignored. + */ + contrast?: number; + /** + * Increase exposure by a factor. A value of 1.0 equals no change, a value of + * 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored. + */ + gamma?: number; + /** + * Increase contrast by a factor. A value of 1.0 equals no change, a value of + * 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is + * ignored. + */ + saturation?: number; + /** + * Flips the images horizontally, vertically, or both. Flipping is applied before + * rotation, so if you apply flip=h,rotate=90 then the image will be flipped + * horizontally, then rotated by 90 degrees. + */ + flip?: 'h' | 'v' | 'hv'; + /** + * Slightly reduces latency on a cache miss by selecting a + * quickest-to-compress file format, at a cost of increased file size and + * lower image quality. It will usually override the format option and choose + * JPEG over WebP or AVIF. We do not recommend using this option, except in + * unusual circumstances like resizing uncacheable dynamically-generated + * images. + */ + compression?: "fast"; +} +interface RequestInitCfPropertiesImageMinify { + javascript?: boolean; + css?: boolean; + html?: boolean; +} +interface RequestInitCfPropertiesR2 { + /** + * Colo id of bucket that an object is stored in + */ + bucketColoId?: number; +} +/** + * Request metadata provided by Cloudflare's edge. + */ +type IncomingRequestCfProperties = IncomingRequestCfPropertiesBase & IncomingRequestCfPropertiesBotManagementEnterprise & IncomingRequestCfPropertiesCloudflareForSaaSEnterprise & IncomingRequestCfPropertiesGeographicInformation & IncomingRequestCfPropertiesCloudflareAccessOrApiShield; +interface IncomingRequestCfPropertiesBase extends Record { + /** + * [ASN](https://www.iana.org/assignments/as-numbers/as-numbers.xhtml) of the incoming request. + * + * @example 395747 + */ + asn?: number; + /** + * The organization which owns the ASN of the incoming request. + * + * @example "Google Cloud" + */ + asOrganization?: string; + /** + * The original value of the `Accept-Encoding` header if Cloudflare modified it. + * + * @example "gzip, deflate, br" + */ + clientAcceptEncoding?: string; + /** + * The number of milliseconds it took for the request to reach your worker. + * + * @example 22 + */ + clientTcpRtt?: number; + /** + * The three-letter [IATA](https://en.wikipedia.org/wiki/IATA_airport_code) + * airport code of the data center that the request hit. + * + * @example "DFW" + */ + colo: string; + /** + * Represents the upstream's response to a + * [TCP `keepalive` message](https://tldp.org/HOWTO/TCP-Keepalive-HOWTO/overview.html) + * from cloudflare. + * + * For workers with no upstream, this will always be `1`. + * + * @example 3 + */ + edgeRequestKeepAliveStatus: IncomingRequestCfPropertiesEdgeRequestKeepAliveStatus; + /** + * The HTTP Protocol the request used. + * + * @example "HTTP/2" + */ + httpProtocol: string; + /** + * The browser-requested prioritization information in the request object. + * + * If no information was set, defaults to the empty string `""` + * + * @example "weight=192;exclusive=0;group=3;group-weight=127" + * @default "" + */ + requestPriority: string; + /** + * The TLS version of the connection to Cloudflare. + * In requests served over plaintext (without TLS), this property is the empty string `""`. + * + * @example "TLSv1.3" + */ + tlsVersion: string; + /** + * The cipher for the connection to Cloudflare. + * In requests served over plaintext (without TLS), this property is the empty string `""`. + * + * @example "AEAD-AES128-GCM-SHA256" + */ + tlsCipher: string; + /** + * Metadata containing the [`HELLO`](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.1.2) and [`FINISHED`](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.9) messages from this request's TLS handshake. + * + * If the incoming request was served over plaintext (without TLS) this field is undefined. + */ + tlsExportedAuthenticator?: IncomingRequestCfPropertiesExportedAuthenticatorMetadata; +} +interface IncomingRequestCfPropertiesBotManagementBase { + /** + * Cloudflare’s [level of certainty](https://developers.cloudflare.com/bots/concepts/bot-score/) that a request comes from a bot, + * represented as an integer percentage between `1` (almost certainly a bot) and `99` (almost certainly human). + * + * @example 54 + */ + score: number; + /** + * A boolean value that is true if the request comes from a good bot, like Google or Bing. + * Most customers choose to allow this traffic. For more details, see [Traffic from known bots](https://developers.cloudflare.com/firewall/known-issues-and-faq/#how-does-firewall-rules-handle-traffic-from-known-bots). + */ + verifiedBot: boolean; + /** + * A boolean value that is true if the request originates from a + * Cloudflare-verified proxy service. + */ + corporateProxy: boolean; + /** + * A boolean value that's true if the request matches [file extensions](https://developers.cloudflare.com/bots/reference/static-resources/) for many types of static resources. + */ + staticResource: boolean; + /** + * List of IDs that correlate to the Bot Management heuristic detections made on a request (you can have multiple heuristic detections on the same request). + */ + detectionIds: number[]; +} +interface IncomingRequestCfPropertiesBotManagement { + /** + * Results of Cloudflare's Bot Management analysis + */ + botManagement: IncomingRequestCfPropertiesBotManagementBase; + /** + * Duplicate of `botManagement.score`. + * + * @deprecated + */ + clientTrustScore: number; +} +interface IncomingRequestCfPropertiesBotManagementEnterprise extends IncomingRequestCfPropertiesBotManagement { + /** + * Results of Cloudflare's Bot Management analysis + */ + botManagement: IncomingRequestCfPropertiesBotManagementBase & { + /** + * A [JA3 Fingerprint](https://developers.cloudflare.com/bots/concepts/ja3-fingerprint/) to help profile specific SSL/TLS clients + * across different destination IPs, Ports, and X509 certificates. + */ + ja3Hash: string; + }; +} +interface IncomingRequestCfPropertiesCloudflareForSaaSEnterprise { + /** + * Custom metadata set per-host in [Cloudflare for SaaS](https://developers.cloudflare.com/cloudflare-for-platforms/cloudflare-for-saas/). + * + * This field is only present if you have Cloudflare for SaaS enabled on your account + * and you have followed the [required steps to enable it]((https://developers.cloudflare.com/cloudflare-for-platforms/cloudflare-for-saas/domain-support/custom-metadata/)). + */ + hostMetadata?: HostMetadata; +} +interface IncomingRequestCfPropertiesCloudflareAccessOrApiShield { + /** + * Information about the client certificate presented to Cloudflare. + * + * This is populated when the incoming request is served over TLS using + * either Cloudflare Access or API Shield (mTLS) + * and the presented SSL certificate has a valid + * [Certificate Serial Number](https://ldapwiki.com/wiki/Certificate%20Serial%20Number) + * (i.e., not `null` or `""`). + * + * Otherwise, a set of placeholder values are used. + * + * The property `certPresented` will be set to `"1"` when + * the object is populated (i.e. the above conditions were met). + */ + tlsClientAuth: IncomingRequestCfPropertiesTLSClientAuth | IncomingRequestCfPropertiesTLSClientAuthPlaceholder; +} +/** + * Metadata about the request's TLS handshake + */ +interface IncomingRequestCfPropertiesExportedAuthenticatorMetadata { + /** + * The client's [`HELLO` message](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.1.2), encoded in hexadecimal + * + * @example "44372ba35fa1270921d318f34c12f155dc87b682cf36a790cfaa3ba8737a1b5d" + */ + clientHandshake: string; + /** + * The server's [`HELLO` message](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.1.2), encoded in hexadecimal + * + * @example "44372ba35fa1270921d318f34c12f155dc87b682cf36a790cfaa3ba8737a1b5d" + */ + serverHandshake: string; + /** + * The client's [`FINISHED` message](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.9), encoded in hexadecimal + * + * @example "084ee802fe1348f688220e2a6040a05b2199a761f33cf753abb1b006792d3f8b" + */ + clientFinished: string; + /** + * The server's [`FINISHED` message](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.9), encoded in hexadecimal + * + * @example "084ee802fe1348f688220e2a6040a05b2199a761f33cf753abb1b006792d3f8b" + */ + serverFinished: string; +} +/** + * Geographic data about the request's origin. + */ +interface IncomingRequestCfPropertiesGeographicInformation { + /** + * The [ISO 3166-1 Alpha 2](https://www.iso.org/iso-3166-country-codes.html) country code the request originated from. + * + * If your worker is [configured to accept TOR connections](https://support.cloudflare.com/hc/en-us/articles/203306930-Understanding-Cloudflare-Tor-support-and-Onion-Routing), this may also be `"T1"`, indicating a request that originated over TOR. + * + * If Cloudflare is unable to determine where the request originated this property is omitted. + * + * The country code `"T1"` is used for requests originating on TOR. + * + * @example "GB" + */ + country?: Iso3166Alpha2Code | "T1"; + /** + * If present, this property indicates that the request originated in the EU + * + * @example "1" + */ + isEUCountry?: "1"; + /** + * A two-letter code indicating the continent the request originated from. + * + * @example "AN" + */ + continent?: ContinentCode; + /** + * The city the request originated from + * + * @example "Austin" + */ + city?: string; + /** + * Postal code of the incoming request + * + * @example "78701" + */ + postalCode?: string; + /** + * Latitude of the incoming request + * + * @example "30.27130" + */ + latitude?: string; + /** + * Longitude of the incoming request + * + * @example "-97.74260" + */ + longitude?: string; + /** + * Timezone of the incoming request + * + * @example "America/Chicago" + */ + timezone?: string; + /** + * If known, the ISO 3166-2 name for the first level region associated with + * the IP address of the incoming request + * + * @example "Texas" + */ + region?: string; + /** + * If known, the ISO 3166-2 code for the first-level region associated with + * the IP address of the incoming request + * + * @example "TX" + */ + regionCode?: string; + /** + * Metro code (DMA) of the incoming request + * + * @example "635" + */ + metroCode?: string; +} +/** Data about the incoming request's TLS certificate */ +interface IncomingRequestCfPropertiesTLSClientAuth { + /** Always `"1"`, indicating that the certificate was presented */ + certPresented: "1"; + /** + * Result of certificate verification. + * + * @example "FAILED:self signed certificate" + */ + certVerified: Exclude; + /** The presented certificate's revokation status. + * + * - A value of `"1"` indicates the certificate has been revoked + * - A value of `"0"` indicates the certificate has not been revoked + */ + certRevoked: "1" | "0"; + /** + * The certificate issuer's [distinguished name](https://knowledge.digicert.com/generalinformation/INFO1745.html) + * + * @example "CN=cloudflareaccess.com, C=US, ST=Texas, L=Austin, O=Cloudflare" + */ + certIssuerDN: string; + /** + * The certificate subject's [distinguished name](https://knowledge.digicert.com/generalinformation/INFO1745.html) + * + * @example "CN=*.cloudflareaccess.com, C=US, ST=Texas, L=Austin, O=Cloudflare" + */ + certSubjectDN: string; + /** + * The certificate issuer's [distinguished name](https://knowledge.digicert.com/generalinformation/INFO1745.html) ([RFC 2253](https://www.rfc-editor.org/rfc/rfc2253.html) formatted) + * + * @example "CN=cloudflareaccess.com, C=US, ST=Texas, L=Austin, O=Cloudflare" + */ + certIssuerDNRFC2253: string; + /** + * The certificate subject's [distinguished name](https://knowledge.digicert.com/generalinformation/INFO1745.html) ([RFC 2253](https://www.rfc-editor.org/rfc/rfc2253.html) formatted) + * + * @example "CN=*.cloudflareaccess.com, C=US, ST=Texas, L=Austin, O=Cloudflare" + */ + certSubjectDNRFC2253: string; + /** The certificate issuer's distinguished name (legacy policies) */ + certIssuerDNLegacy: string; + /** The certificate subject's distinguished name (legacy policies) */ + certSubjectDNLegacy: string; + /** + * The certificate's serial number + * + * @example "00936EACBE07F201DF" + */ + certSerial: string; + /** + * The certificate issuer's serial number + * + * @example "2489002934BDFEA34" + */ + certIssuerSerial: string; + /** + * The certificate's Subject Key Identifier + * + * @example "BB:AF:7E:02:3D:FA:A6:F1:3C:84:8E:AD:EE:38:98:EC:D9:32:32:D4" + */ + certSKI: string; + /** + * The certificate issuer's Subject Key Identifier + * + * @example "BB:AF:7E:02:3D:FA:A6:F1:3C:84:8E:AD:EE:38:98:EC:D9:32:32:D4" + */ + certIssuerSKI: string; + /** + * The certificate's SHA-1 fingerprint + * + * @example "6b9109f323999e52259cda7373ff0b4d26bd232e" + */ + certFingerprintSHA1: string; + /** + * The certificate's SHA-256 fingerprint + * + * @example "acf77cf37b4156a2708e34c4eb755f9b5dbbe5ebb55adfec8f11493438d19e6ad3f157f81fa3b98278453d5652b0c1fd1d71e5695ae4d709803a4d3f39de9dea" + */ + certFingerprintSHA256: string; + /** + * The effective starting date of the certificate + * + * @example "Dec 22 19:39:00 2018 GMT" + */ + certNotBefore: string; + /** + * The effective expiration date of the certificate + * + * @example "Dec 22 19:39:00 2018 GMT" + */ + certNotAfter: string; +} +/** Placeholder values for TLS Client Authorization */ +interface IncomingRequestCfPropertiesTLSClientAuthPlaceholder { + certPresented: "0"; + certVerified: "NONE"; + certRevoked: "0"; + certIssuerDN: ""; + certSubjectDN: ""; + certIssuerDNRFC2253: ""; + certSubjectDNRFC2253: ""; + certIssuerDNLegacy: ""; + certSubjectDNLegacy: ""; + certSerial: ""; + certIssuerSerial: ""; + certSKI: ""; + certIssuerSKI: ""; + certFingerprintSHA1: ""; + certFingerprintSHA256: ""; + certNotBefore: ""; + certNotAfter: ""; +} +/** Possible outcomes of TLS verification */ +declare type CertVerificationStatus = +/** Authentication succeeded */ +"SUCCESS" +/** No certificate was presented */ + | "NONE" +/** Failed because the certificate was self-signed */ + | "FAILED:self signed certificate" +/** Failed because the certificate failed a trust chain check */ + | "FAILED:unable to verify the first certificate" +/** Failed because the certificate not yet valid */ + | "FAILED:certificate is not yet valid" +/** Failed because the certificate is expired */ + | "FAILED:certificate has expired" +/** Failed for another unspecified reason */ + | "FAILED"; +/** + * An upstream endpoint's response to a TCP `keepalive` message from Cloudflare. + */ +declare type IncomingRequestCfPropertiesEdgeRequestKeepAliveStatus = 0 /** Unknown */ | 1 /** no keepalives (not found) */ | 2 /** no connection re-use, opening keepalive connection failed */ | 3 /** no connection re-use, keepalive accepted and saved */ | 4 /** connection re-use, refused by the origin server (`TCP FIN`) */ | 5; /** connection re-use, accepted by the origin server */ +/** ISO 3166-1 Alpha-2 codes */ +declare type Iso3166Alpha2Code = "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW"; +/** The 2-letter continent codes Cloudflare uses */ +declare type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA"; +type CfProperties = IncomingRequestCfProperties | RequestInitCfProperties; +interface D1Meta { + duration: number; + size_after: number; + rows_read: number; + rows_written: number; + last_row_id: number; + changed_db: boolean; + changes: number; + /** + * The region of the database instance that executed the query. + */ + served_by_region?: string; + /** + * The three letters airport code of the colo that executed the query. + */ + served_by_colo?: string; + /** + * True if-and-only-if the database instance that executed the query was the primary. + */ + served_by_primary?: boolean; + timings?: { + /** + * The duration of the SQL query execution by the database instance. It doesn't include any network time. + */ + sql_duration_ms: number; + }; + /** + * Number of total attempts to execute the query, due to automatic retries. + * Note: All other fields in the response like `timings` only apply to the last attempt. + */ + total_attempts?: number; +} +interface D1Response { + success: true; + meta: D1Meta & Record; + error?: never; +} +type D1Result = D1Response & { + results: T[]; +}; +interface D1ExecResult { + count: number; + duration: number; +} +type D1SessionConstraint = +// Indicates that the first query should go to the primary, and the rest queries +// using the same D1DatabaseSession will go to any replica that is consistent with +// the bookmark maintained by the session (returned by the first query). +'first-primary' +// Indicates that the first query can go anywhere (primary or replica), and the rest queries +// using the same D1DatabaseSession will go to any replica that is consistent with +// the bookmark maintained by the session (returned by the first query). + | 'first-unconstrained'; +type D1SessionBookmark = string; +declare abstract class D1Database { + prepare(query: string): D1PreparedStatement; + batch(statements: D1PreparedStatement[]): Promise[]>; + exec(query: string): Promise; + /** + * Creates a new D1 Session anchored at the given constraint or the bookmark. + * All queries executed using the created session will have sequential consistency, + * meaning that all writes done through the session will be visible in subsequent reads. + * + * @param constraintOrBookmark Either the session constraint or the explicit bookmark to anchor the created session. + */ + withSession(constraintOrBookmark?: D1SessionBookmark | D1SessionConstraint): D1DatabaseSession; + /** + * @deprecated dump() will be removed soon, only applies to deprecated alpha v1 databases. + */ + dump(): Promise; +} +declare abstract class D1DatabaseSession { + prepare(query: string): D1PreparedStatement; + batch(statements: D1PreparedStatement[]): Promise[]>; + /** + * @returns The latest session bookmark across all executed queries on the session. + * If no query has been executed yet, `null` is returned. + */ + getBookmark(): D1SessionBookmark | null; +} +declare abstract class D1PreparedStatement { + bind(...values: unknown[]): D1PreparedStatement; + first(colName: string): Promise; + first>(): Promise; + run>(): Promise>; + all>(): Promise>; + raw(options: { + columnNames: true; + }): Promise<[ + string[], + ...T[] + ]>; + raw(options?: { + columnNames?: false; + }): Promise; +} +// `Disposable` was added to TypeScript's standard lib types in version 5.2. +// To support older TypeScript versions, define an empty `Disposable` interface. +// Users won't be able to use `using`/`Symbol.dispose` without upgrading to 5.2, +// but this will ensure type checking on older versions still passes. +// TypeScript's interface merging will ensure our empty interface is effectively +// ignored when `Disposable` is included in the standard lib. +interface Disposable { +} +/** + * The returned data after sending an email + */ +interface EmailSendResult { + /** + * The Email Message ID + */ + messageId: string; +} +/** + * An email message that can be sent from a Worker. + */ +interface EmailMessage { + /** + * Envelope From attribute of the email message. + */ + readonly from: string; + /** + * Envelope To attribute of the email message. + */ + readonly to: string; +} +/** + * An email message that is sent to a consumer Worker and can be rejected/forwarded. + */ +interface ForwardableEmailMessage extends EmailMessage { + /** + * Stream of the email message content. + */ + readonly raw: ReadableStream; + /** + * An [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers). + */ + readonly headers: Headers; + /** + * Size of the email message content. + */ + readonly rawSize: number; + /** + * Reject this email message by returning a permanent SMTP error back to the connecting client including the given reason. + * @param reason The reject reason. + * @returns void + */ + setReject(reason: string): void; + /** + * Forward this email message to a verified destination address of the account. + * @param rcptTo Verified destination address. + * @param headers A [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers). + * @returns A promise that resolves when the email message is forwarded. + */ + forward(rcptTo: string, headers?: Headers): Promise; + /** + * Reply to the sender of this email message with a new EmailMessage object. + * @param message The reply message. + * @returns A promise that resolves when the email message is replied. + */ + reply(message: EmailMessage): Promise; +} +/** A file attachment for an email message */ +type EmailAttachment = { + disposition: 'inline'; + contentId: string; + filename: string; + type: string; + content: string | ArrayBuffer | ArrayBufferView; +} | { + disposition: 'attachment'; + contentId?: undefined; + filename: string; + type: string; + content: string | ArrayBuffer | ArrayBufferView; +}; +/** An Email Address */ +interface EmailAddress { + name: string; + email: string; +} +/** + * A binding that allows a Worker to send email messages. + */ +interface SendEmail { + send(message: EmailMessage): Promise; + send(builder: { + from: string | EmailAddress; + to: string | string[]; + subject: string; + replyTo?: string | EmailAddress; + cc?: string | string[]; + bcc?: string | string[]; + headers?: Record; + text?: string; + html?: string; + attachments?: EmailAttachment[]; + }): Promise; +} +declare abstract class EmailEvent extends ExtendableEvent { + readonly message: ForwardableEmailMessage; +} +declare type EmailExportedHandler = (message: ForwardableEmailMessage, env: Env, ctx: ExecutionContext) => void | Promise; +declare module "cloudflare:email" { + let _EmailMessage: { + prototype: EmailMessage; + new (from: string, to: string, raw: ReadableStream | string): EmailMessage; + }; + export { _EmailMessage as EmailMessage }; +} +/** + * Evaluation context for targeting rules. + * Keys are attribute names (e.g. "userId", "country"), values are the attribute values. + */ +type FlagshipEvaluationContext = Record; +interface FlagshipEvaluationDetails { + flagKey: string; + value: T; + variant?: string | undefined; + reason?: string | undefined; + errorCode?: string | undefined; + errorMessage?: string | undefined; +} +interface FlagshipEvaluationError extends Error { +} +/** + * Feature flags binding for evaluating feature flags from a Cloudflare Workers script. + * + * @example + * ```typescript + * // Get a boolean flag value with a default + * const enabled = await env.FLAGS.getBooleanValue('my-feature', false); + * + * // Get a flag value with evaluation context for targeting + * const variant = await env.FLAGS.getStringValue('experiment', 'control', { + * userId: 'user-123', + * country: 'US', + * }); + * + * // Get full evaluation details including variant and reason + * const details = await env.FLAGS.getBooleanDetails('my-feature', false); + * console.log(details.variant, details.reason); + * ``` + */ +declare abstract class Flagship { + /** + * Get a flag value without type checking. + * @param flagKey The key of the flag to evaluate. + * @param defaultValue Optional default value returned when evaluation fails. + * @param context Optional evaluation context for targeting rules. + */ + get(flagKey: string, defaultValue?: unknown, context?: FlagshipEvaluationContext): Promise; + /** + * Get a boolean flag value. + * @param flagKey The key of the flag to evaluate. + * @param defaultValue Default value returned when evaluation fails or the flag type does not match. + * @param context Optional evaluation context for targeting rules. + */ + getBooleanValue(flagKey: string, defaultValue: boolean, context?: FlagshipEvaluationContext): Promise; + /** + * Get a string flag value. + * @param flagKey The key of the flag to evaluate. + * @param defaultValue Default value returned when evaluation fails or the flag type does not match. + * @param context Optional evaluation context for targeting rules. + */ + getStringValue(flagKey: string, defaultValue: string, context?: FlagshipEvaluationContext): Promise; + /** + * Get a number flag value. + * @param flagKey The key of the flag to evaluate. + * @param defaultValue Default value returned when evaluation fails or the flag type does not match. + * @param context Optional evaluation context for targeting rules. + */ + getNumberValue(flagKey: string, defaultValue: number, context?: FlagshipEvaluationContext): Promise; + /** + * Get an object flag value. + * @param flagKey The key of the flag to evaluate. + * @param defaultValue Default value returned when evaluation fails or the flag type does not match. + * @param context Optional evaluation context for targeting rules. + */ + getObjectValue(flagKey: string, defaultValue: T, context?: FlagshipEvaluationContext): Promise; + /** + * Get a boolean flag value with full evaluation details. + * @param flagKey The key of the flag to evaluate. + * @param defaultValue Default value returned when evaluation fails or the flag type does not match. + * @param context Optional evaluation context for targeting rules. + */ + getBooleanDetails(flagKey: string, defaultValue: boolean, context?: FlagshipEvaluationContext): Promise>; + /** + * Get a string flag value with full evaluation details. + * @param flagKey The key of the flag to evaluate. + * @param defaultValue Default value returned when evaluation fails or the flag type does not match. + * @param context Optional evaluation context for targeting rules. + */ + getStringDetails(flagKey: string, defaultValue: string, context?: FlagshipEvaluationContext): Promise>; + /** + * Get a number flag value with full evaluation details. + * @param flagKey The key of the flag to evaluate. + * @param defaultValue Default value returned when evaluation fails or the flag type does not match. + * @param context Optional evaluation context for targeting rules. + */ + getNumberDetails(flagKey: string, defaultValue: number, context?: FlagshipEvaluationContext): Promise>; + /** + * Get an object flag value with full evaluation details. + * @param flagKey The key of the flag to evaluate. + * @param defaultValue Default value returned when evaluation fails or the flag type does not match. + * @param context Optional evaluation context for targeting rules. + */ + getObjectDetails(flagKey: string, defaultValue: T, context?: FlagshipEvaluationContext): Promise>; +} +/** + * Hello World binding to serve as an explanatory example. DO NOT USE + */ +interface HelloWorldBinding { + /** + * Retrieve the current stored value + */ + get(): Promise<{ + value: string; + ms?: number; + }>; + /** + * Set a new stored value + */ + set(value: string): Promise; +} +interface Hyperdrive { + /** + * Connect directly to Hyperdrive as if it's your database, returning a TCP socket. + * + * Calling this method returns an identical socket to if you call + * `connect("host:port")` using the `host` and `port` fields from this object. + * Pick whichever approach works better with your preferred DB client library. + * + * Note that this socket is not yet authenticated -- it's expected that your + * code (or preferably, the client library of your choice) will authenticate + * using the information in this class's readonly fields. + */ + connect(): Socket; + /** + * A valid DB connection string that can be passed straight into the typical + * client library/driver/ORM. This will typically be the easiest way to use + * Hyperdrive. + */ + readonly connectionString: string; + /* + * A randomly generated hostname that is only valid within the context of the + * currently running Worker which, when passed into `connect()` function from + * the "cloudflare:sockets" module, will connect to the Hyperdrive instance + * for your database. + */ + readonly host: string; + /* + * The port that must be paired the the host field when connecting. + */ + readonly port: number; + /* + * The username to use when authenticating to your database via Hyperdrive. + * Unlike the host and password, this will be the same every time + */ + readonly user: string; + /* + * The randomly generated password to use when authenticating to your + * database via Hyperdrive. Like the host field, this password is only valid + * within the context of the currently running Worker instance from which + * it's read. + */ + readonly password: string; + /* + * The name of the database to connect to. + */ + readonly database: string; +} +// Copyright (c) 2024 Cloudflare, Inc. +// Licensed under the Apache 2.0 license found in the LICENSE file or at: +// https://opensource.org/licenses/Apache-2.0 +type ImageInfoResponse = { + format: 'image/svg+xml'; +} | { + format: string; + fileSize: number; + width: number; + height: number; +}; +type ImageTransform = { + width?: number; + height?: number; + background?: string; + blur?: number; + border?: { + color?: string; + width?: number; + } | { + top?: number; + bottom?: number; + left?: number; + right?: number; + }; + brightness?: number; + contrast?: number; + fit?: 'scale-down' | 'contain' | 'pad' | 'squeeze' | 'cover' | 'crop'; + flip?: 'h' | 'v' | 'hv'; + gamma?: number; + segment?: 'foreground'; + gravity?: 'face' | 'left' | 'right' | 'top' | 'bottom' | 'center' | 'auto' | 'entropy' | { + x?: number; + y?: number; + mode: 'remainder' | 'box-center'; + }; + rotate?: 0 | 90 | 180 | 270; + saturation?: number; + sharpen?: number; + trim?: 'border' | { + top?: number; + bottom?: number; + left?: number; + right?: number; + width?: number; + height?: number; + border?: boolean | { + color?: string; + tolerance?: number; + keep?: number; + }; + }; +}; +type ImageDrawOptions = { + opacity?: number; + repeat?: boolean | string; + top?: number; + left?: number; + bottom?: number; + right?: number; +}; +type ImageInputOptions = { + encoding?: 'base64'; +}; +type ImageOutputOptions = { + format: 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp' | 'image/avif' | 'rgb' | 'rgba'; + quality?: number; + background?: string; + anim?: boolean; +}; +interface ImageMetadata { + id: string; + filename?: string; + uploaded?: string; + requireSignedURLs: boolean; + meta?: Record; + variants: string[]; + draft?: boolean; + creator?: string; +} +interface ImageUploadOptions { + id?: string; + filename?: string; + requireSignedURLs?: boolean; + metadata?: Record; + creator?: string; + encoding?: 'base64'; +} +interface ImageUpdateOptions { + requireSignedURLs?: boolean; + metadata?: Record; + creator?: string; +} +interface ImageListOptions { + limit?: number; + cursor?: string; + sortOrder?: 'asc' | 'desc'; + creator?: string; +} +interface ImageList { + images: ImageMetadata[]; + cursor?: string; + listComplete: boolean; +} +interface ImageHandle { + /** + * Get metadata for a hosted image + * @returns Image metadata, or null if not found + */ + details(): Promise; + /** + * Get the raw image data for a hosted image + * @returns ReadableStream of image bytes, or null if not found + */ + bytes(): Promise | null>; + /** + * Update hosted image metadata + * @param options Properties to update + * @returns Updated image metadata + * @throws {@link ImagesError} if update fails + */ + update(options: ImageUpdateOptions): Promise; + /** + * Delete a hosted image + * @returns True if deleted, false if not found + */ + delete(): Promise; +} +interface HostedImagesBinding { + /** + * Get a handle for a hosted image + * @param imageId The ID of the image (UUID or custom ID) + * @returns A handle for per-image operations + */ + image(imageId: string): ImageHandle; + /** + * Upload a new hosted image + * @param image The image file to upload + * @param options Upload configuration + * @returns Metadata for the uploaded image + * @throws {@link ImagesError} if upload fails + */ + upload(image: ReadableStream | ArrayBuffer, options?: ImageUploadOptions): Promise; + /** + * List hosted images with pagination + * @param options List configuration + * @returns List of images with pagination info + * @throws {@link ImagesError} if list fails + */ + list(options?: ImageListOptions): Promise; +} +interface ImagesBinding { + /** + * Get image metadata (type, width and height) + * @throws {@link ImagesError} with code 9412 if input is not an image + * @param stream The image bytes + */ + info(stream: ReadableStream, options?: ImageInputOptions): Promise; + /** + * Begin applying a series of transformations to an image + * @param stream The image bytes + * @returns A transform handle + */ + input(stream: ReadableStream, options?: ImageInputOptions): ImageTransformer; + /** + * Access hosted images CRUD operations + */ + readonly hosted: HostedImagesBinding; +} +interface ImageTransformer { + /** + * Apply transform next, returning a transform handle. + * You can then apply more transformations, draw, or retrieve the output. + * @param transform + */ + transform(transform: ImageTransform): ImageTransformer; + /** + * Draw an image on this transformer, returning a transform handle. + * You can then apply more transformations, draw, or retrieve the output. + * @param image The image (or transformer that will give the image) to draw + * @param options The options configuring how to draw the image + */ + draw(image: ReadableStream | ImageTransformer, options?: ImageDrawOptions): ImageTransformer; + /** + * Retrieve the image that results from applying the transforms to the + * provided input + * @param options Options that apply to the output e.g. output format + */ + output(options: ImageOutputOptions): Promise; +} +type ImageTransformationOutputOptions = { + encoding?: 'base64'; +}; +interface ImageTransformationResult { + /** + * The image as a response, ready to store in cache or return to users + */ + response(): Response; + /** + * The content type of the returned image + */ + contentType(): string; + /** + * The bytes of the response + */ + image(options?: ImageTransformationOutputOptions): ReadableStream; +} +interface ImagesError extends Error { + readonly code: number; + readonly message: string; + readonly stack?: string; +} +/** + * Media binding for transforming media streams. + * Provides the entry point for media transformation operations. + */ +interface MediaBinding { + /** + * Creates a media transformer from an input stream. + * @param media - The input media bytes + * @returns A MediaTransformer instance for applying transformations + */ + input(media: ReadableStream): MediaTransformer; +} +/** + * Media transformer for applying transformation operations to media content. + * Handles sizing, fitting, and other input transformation parameters. + */ +interface MediaTransformer { + /** + * Applies transformation options to the media content. + * @param transform - Configuration for how the media should be transformed + * @returns A generator for producing the transformed media output + */ + transform(transform?: MediaTransformationInputOptions): MediaTransformationGenerator; + /** + * Generates the final media output with specified options. + * @param output - Configuration for the output format and parameters + * @returns The final transformation result containing the transformed media + */ + output(output?: MediaTransformationOutputOptions): MediaTransformationResult; +} +/** + * Generator for producing media transformation results. + * Configures the output format and parameters for the transformed media. + */ +interface MediaTransformationGenerator { + /** + * Generates the final media output with specified options. + * @param output - Configuration for the output format and parameters + * @returns The final transformation result containing the transformed media + */ + output(output?: MediaTransformationOutputOptions): MediaTransformationResult; +} +/** + * Result of a media transformation operation. + * Provides multiple ways to access the transformed media content. + */ +interface MediaTransformationResult { + /** + * Returns the transformed media as a readable stream of bytes. + * @returns A promise containing a readable stream with the transformed media + */ + media(): Promise>; + /** + * Returns the transformed media as an HTTP response object. + * @returns The transformed media as a Promise, ready to store in cache or return to users + */ + response(): Promise; + /** + * Returns the MIME type of the transformed media. + * @returns A promise containing the content type string (e.g., 'image/jpeg', 'video/mp4') + */ + contentType(): Promise; +} +/** + * Configuration options for transforming media input. + * Controls how the media should be resized and fitted. + */ +type MediaTransformationInputOptions = { + /** How the media should be resized to fit the specified dimensions */ + fit?: 'contain' | 'cover' | 'scale-down'; + /** Target width in pixels */ + width?: number; + /** Target height in pixels */ + height?: number; +}; +/** + * Configuration options for Media Transformations output. + * Controls the format, timing, and type of the generated output. + */ +type MediaTransformationOutputOptions = { + /** + * Output mode determining the type of media to generate + */ + mode?: 'video' | 'spritesheet' | 'frame' | 'audio'; + /** Whether to include audio in the output */ + audio?: boolean; + /** + * Starting timestamp for frame extraction or start time for clips. (e.g. '2s'). + */ + time?: string; + /** + * Duration for video clips, audio extraction, and spritesheet generation (e.g. '5s'). + */ + duration?: string; + /** + * Number of frames in the spritesheet. + */ + imageCount?: number; + /** + * Output format for the generated media. + */ + format?: 'jpg' | 'png' | 'm4a'; +}; +/** + * Error object for media transformation operations. + * Extends the standard Error interface with additional media-specific information. + */ +interface MediaError extends Error { + readonly code: number; + readonly message: string; + readonly stack?: string; +} +declare module 'cloudflare:node' { + interface NodeStyleServer { + listen(...args: unknown[]): this; + address(): { + port?: number | null | undefined; + }; + } + export function httpServerHandler(port: number): ExportedHandler; + export function httpServerHandler(options: { + port: number; + }): ExportedHandler; + export function httpServerHandler(server: NodeStyleServer): ExportedHandler; +} +type Params

= Record; +type EventContext = { + request: Request>; + functionPath: string; + waitUntil: (promise: Promise) => void; + passThroughOnException: () => void; + next: (input?: Request | string, init?: RequestInit) => Promise; + env: Env & { + ASSETS: { + fetch: typeof fetch; + }; + }; + params: Params

; + data: Data; +}; +type PagesFunction = Record> = (context: EventContext) => Response | Promise; +type EventPluginContext = { + request: Request>; + functionPath: string; + waitUntil: (promise: Promise) => void; + passThroughOnException: () => void; + next: (input?: Request | string, init?: RequestInit) => Promise; + env: Env & { + ASSETS: { + fetch: typeof fetch; + }; + }; + params: Params

; + data: Data; + pluginArgs: PluginArgs; +}; +type PagesPluginFunction = Record, PluginArgs = unknown> = (context: EventPluginContext) => Response | Promise; +declare module "assets:*" { + export const onRequest: PagesFunction; +} +// Copyright (c) 2022-2023 Cloudflare, Inc. +// Licensed under the Apache 2.0 license found in the LICENSE file or at: +// https://opensource.org/licenses/Apache-2.0 +declare module "cloudflare:pipelines" { + export abstract class PipelineTransformationEntrypoint { + protected env: Env; + protected ctx: ExecutionContext; + constructor(ctx: ExecutionContext, env: Env); + /** + * run receives an array of PipelineRecord which can be + * transformed and returned to the pipeline + * @param records Incoming records from the pipeline to be transformed + * @param metadata Information about the specific pipeline calling the transformation entrypoint + * @returns A promise containing the transformed PipelineRecord array + */ + public run(records: I[], metadata: PipelineBatchMetadata): Promise; + } + export type PipelineRecord = Record; + export type PipelineBatchMetadata = { + pipelineId: string; + pipelineName: string; + }; + export interface Pipeline { + /** + * The Pipeline interface represents the type of a binding to a Pipeline + * + * @param records The records to send to the pipeline + */ + send(records: T[]): Promise; + } +} +// PubSubMessage represents an incoming PubSub message. +// The message includes metadata about the broker, the client, and the payload +// itself. +// https://developers.cloudflare.com/pub-sub/ +interface PubSubMessage { + // Message ID + readonly mid: number; + // MQTT broker FQDN in the form mqtts://BROKER.NAMESPACE.cloudflarepubsub.com:PORT + readonly broker: string; + // The MQTT topic the message was sent on. + readonly topic: string; + // The client ID of the client that published this message. + readonly clientId: string; + // The unique identifier (JWT ID) used by the client to authenticate, if token + // auth was used. + readonly jti?: string; + // A Unix timestamp (seconds from Jan 1, 1970), set when the Pub/Sub Broker + // received the message from the client. + readonly receivedAt: number; + // An (optional) string with the MIME type of the payload, if set by the + // client. + readonly contentType: string; + // Set to 1 when the payload is a UTF-8 string + // https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901063 + readonly payloadFormatIndicator: number; + // Pub/Sub (MQTT) payloads can be UTF-8 strings, or byte arrays. + // You can use payloadFormatIndicator to inspect this before decoding. + payload: string | Uint8Array; +} +// JsonWebKey extended by kid parameter +interface JsonWebKeyWithKid extends JsonWebKey { + // Key Identifier of the JWK + readonly kid: string; +} +interface RateLimitOptions { + key: string; +} +interface RateLimitOutcome { + success: boolean; +} +interface RateLimit { + /** + * Rate limit a request based on the provided options. + * @see https://developers.cloudflare.com/workers/runtime-apis/bindings/rate-limit/ + * @returns A promise that resolves with the outcome of the rate limit. + */ + limit(options: RateLimitOptions): Promise; +} +// Namespace for RPC utility types. Unfortunately, we can't use a `module` here as these types need +// to referenced by `Fetcher`. This is included in the "importable" version of the types which +// strips all `module` blocks. +declare namespace Rpc { + // Branded types for identifying `WorkerEntrypoint`/`DurableObject`/`Target`s. + // TypeScript uses *structural* typing meaning anything with the same shape as type `T` is a `T`. + // For the classes exported by `cloudflare:workers` we want *nominal* typing (i.e. we only want to + // accept `WorkerEntrypoint` from `cloudflare:workers`, not any other class with the same shape) + export const __RPC_STUB_BRAND: '__RPC_STUB_BRAND'; + export const __RPC_TARGET_BRAND: '__RPC_TARGET_BRAND'; + export const __WORKER_ENTRYPOINT_BRAND: '__WORKER_ENTRYPOINT_BRAND'; + export const __DURABLE_OBJECT_BRAND: '__DURABLE_OBJECT_BRAND'; + export const __WORKFLOW_ENTRYPOINT_BRAND: '__WORKFLOW_ENTRYPOINT_BRAND'; + export interface RpcTargetBranded { + [__RPC_TARGET_BRAND]: never; + } + export interface WorkerEntrypointBranded { + [__WORKER_ENTRYPOINT_BRAND]: never; + } + export interface DurableObjectBranded { + [__DURABLE_OBJECT_BRAND]: never; + } + export interface WorkflowEntrypointBranded { + [__WORKFLOW_ENTRYPOINT_BRAND]: never; + } + export type EntrypointBranded = WorkerEntrypointBranded | DurableObjectBranded | WorkflowEntrypointBranded; + // Types that can be used through `Stub`s + export type Stubable = RpcTargetBranded | ((...args: any[]) => any); + // Types that can be passed over RPC + // The reason for using a generic type here is to build a serializable subset of structured + // cloneable composite types. This allows types defined with the "interface" keyword to pass the + // serializable check as well. Otherwise, only types defined with the "type" keyword would pass. + type Serializable = + // Structured cloneables + BaseType + // Structured cloneable composites + | Map ? Serializable : never, T extends Map ? Serializable : never> | Set ? Serializable : never> | ReadonlyArray ? Serializable : never> | { + [K in keyof T]: K extends number | string ? Serializable : never; + } + // Special types + | Stub + // Serialized as stubs, see `Stubify` + | Stubable; + // Base type for all RPC stubs, including common memory management methods. + // `T` is used as a marker type for unwrapping `Stub`s later. + interface StubBase extends Disposable { + [__RPC_STUB_BRAND]: T; + dup(): this; + } + export type Stub = Provider & StubBase; + // This represents all the types that can be sent as-is over an RPC boundary + type BaseType = void | undefined | null | boolean | number | bigint | string | TypedArray | ArrayBuffer | DataView | Date | Error | RegExp | ReadableStream | WritableStream | Request | Response | Headers; + // Recursively rewrite all `Stubable` types with `Stub`s + // prettier-ignore + type Stubify = T extends Stubable ? Stub : T extends Map ? Map, Stubify> : T extends Set ? Set> : T extends Array ? Array> : T extends ReadonlyArray ? ReadonlyArray> : T extends BaseType ? T : T extends { + [key: string | number]: any; + } ? { + [K in keyof T]: Stubify; + } : T; + // Recursively rewrite all `Stub`s with the corresponding `T`s. + // Note we use `StubBase` instead of `Stub` here to avoid circular dependencies: + // `Stub` depends on `Provider`, which depends on `Unstubify`, which would depend on `Stub`. + // prettier-ignore + type Unstubify = T extends StubBase ? V : T extends Map ? Map, Unstubify> : T extends Set ? Set> : T extends Array ? Array> : T extends ReadonlyArray ? ReadonlyArray> : T extends BaseType ? T : T extends { + [key: string | number]: unknown; + } ? { + [K in keyof T]: Unstubify; + } : T; + type UnstubifyAll = { + [I in keyof A]: Unstubify; + }; + // Utility type for adding `Provider`/`Disposable`s to `object` types only. + // Note `unknown & T` is equivalent to `T`. + type MaybeProvider = T extends object ? Provider : unknown; + type MaybeDisposable = T extends object ? Disposable : unknown; + // Type for method return or property on an RPC interface. + // - Stubable types are replaced by stubs. + // - Serializable types are passed by value, with stubable types replaced by stubs + // and a top-level `Disposer`. + // Everything else can't be passed over PRC. + // Technically, we use custom thenables here, but they quack like `Promise`s. + // Intersecting with `(Maybe)Provider` allows pipelining. + // prettier-ignore + type Result = R extends Stubable ? Promise> & Provider : R extends Serializable ? Promise & MaybeDisposable> & MaybeProvider : never; + // Type for method or property on an RPC interface. + // For methods, unwrap `Stub`s in parameters, and rewrite returns to be `Result`s. + // Unwrapping `Stub`s allows calling with `Stubable` arguments. + // For properties, rewrite types to be `Result`s. + // In each case, unwrap `Promise`s. + type MethodOrProperty = V extends (...args: infer P) => infer R ? (...args: UnstubifyAll

) => Result> : Result>; + // Type for the callable part of an `Provider` if `T` is callable. + // This is intersected with methods/properties. + type MaybeCallableProvider = T extends (...args: any[]) => any ? MethodOrProperty : unknown; + // Base type for all other types providing RPC-like interfaces. + // Rewrites all methods/properties to be `MethodOrProperty`s, while preserving callable types. + // `Reserved` names (e.g. stub method names like `dup()`) and symbols can't be accessed over RPC. + export type Provider = MaybeCallableProvider & Pick<{ + [K in keyof T]: MethodOrProperty; + }, Exclude>>; +} +declare namespace Cloudflare { + // Type of `env`. + // + // The specific project can extend `Env` by redeclaring it in project-specific files. Typescript + // will merge all declarations. + // + // You can use `wrangler types` to generate the `Env` type automatically. + interface Env { + } + // Project-specific parameters used to inform types. + // + // This interface is, again, intended to be declared in project-specific files, and then that + // declaration will be merged with this one. + // + // A project should have a declaration like this: + // + // interface GlobalProps { + // // Declares the main module's exports. Used to populate Cloudflare.Exports aka the type + // // of `ctx.exports`. + // mainModule: typeof import("my-main-module"); + // + // // Declares which of the main module's exports are configured with durable storage, and + // // thus should behave as Durable Object namsepace bindings. + // durableNamespaces: "MyDurableObject" | "AnotherDurableObject"; + // } + // + // You can use `wrangler types` to generate `GlobalProps` automatically. + interface GlobalProps { + } + // Evaluates to the type of a property in GlobalProps, defaulting to `Default` if it is not + // present. + type GlobalProp = K extends keyof GlobalProps ? GlobalProps[K] : Default; + // The type of the program's main module exports, if known. Requires `GlobalProps` to declare the + // `mainModule` property. + type MainModule = GlobalProp<"mainModule", {}>; + // The type of ctx.exports, which contains loopback bindings for all top-level exports. + type Exports = { + [K in keyof MainModule]: LoopbackForExport + // If the export is listed in `durableNamespaces`, then it is also a + // DurableObjectNamespace. + & (K extends GlobalProp<"durableNamespaces", never> ? MainModule[K] extends new (...args: any[]) => infer DoInstance ? DoInstance extends Rpc.DurableObjectBranded ? DurableObjectNamespace : DurableObjectNamespace : DurableObjectNamespace : {}); + }; +} +declare namespace CloudflareWorkersModule { + export type RpcStub = Rpc.Stub; + export const RpcStub: { + new (value: T): Rpc.Stub; + }; + export abstract class RpcTarget implements Rpc.RpcTargetBranded { + [Rpc.__RPC_TARGET_BRAND]: never; + } + // `protected` fields don't appear in `keyof`s, so can't be accessed over RPC + export abstract class WorkerEntrypoint implements Rpc.WorkerEntrypointBranded { + [Rpc.__WORKER_ENTRYPOINT_BRAND]: never; + protected ctx: ExecutionContext; + protected env: Env; + constructor(ctx: ExecutionContext, env: Env); + email?(message: ForwardableEmailMessage): void | Promise; + fetch?(request: Request): Response | Promise; + connect?(socket: Socket): void | Promise; + queue?(batch: MessageBatch): void | Promise; + scheduled?(controller: ScheduledController): void | Promise; + tail?(events: TraceItem[]): void | Promise; + tailStream?(event: TailStream.TailEvent): TailStream.TailEventHandlerType | Promise; + test?(controller: TestController): void | Promise; + trace?(traces: TraceItem[]): void | Promise; + } + export abstract class DurableObject implements Rpc.DurableObjectBranded { + [Rpc.__DURABLE_OBJECT_BRAND]: never; + protected ctx: DurableObjectState; + protected env: Env; + constructor(ctx: DurableObjectState, env: Env); + alarm?(alarmInfo?: AlarmInvocationInfo): void | Promise; + fetch?(request: Request): Response | Promise; + connect?(socket: Socket): void | Promise; + webSocketMessage?(ws: WebSocket, message: string | ArrayBuffer): void | Promise; + webSocketClose?(ws: WebSocket, code: number, reason: string, wasClean: boolean): void | Promise; + webSocketError?(ws: WebSocket, error: unknown): void | Promise; + } + export type WorkflowDurationLabel = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'; + export type WorkflowSleepDuration = `${number} ${WorkflowDurationLabel}${'s' | ''}` | number; + export type WorkflowDelayDuration = WorkflowSleepDuration; + export type WorkflowTimeoutDuration = WorkflowSleepDuration; + export type WorkflowRetentionDuration = WorkflowSleepDuration; + export type WorkflowBackoff = 'constant' | 'linear' | 'exponential'; + export type WorkflowStepConfig = { + retries?: { + limit: number; + delay: WorkflowDelayDuration | number; + backoff?: WorkflowBackoff; + }; + timeout?: WorkflowTimeoutDuration | number; + }; + export type WorkflowEvent = { + payload: Readonly; + timestamp: Date; + instanceId: string; + }; + export type WorkflowStepEvent = { + payload: Readonly; + timestamp: Date; + type: string; + }; + export type WorkflowStepContext = { + step: { + name: string; + count: number; + }; + attempt: number; + config: WorkflowStepConfig; + }; + export abstract class WorkflowStep { + do>(name: string, callback: (ctx: WorkflowStepContext) => Promise): Promise; + do>(name: string, config: WorkflowStepConfig, callback: (ctx: WorkflowStepContext) => Promise): Promise; + sleep: (name: string, duration: WorkflowSleepDuration) => Promise; + sleepUntil: (name: string, timestamp: Date | number) => Promise; + waitForEvent>(name: string, options: { + type: string; + timeout?: WorkflowTimeoutDuration | number; + }): Promise>; + } + export type WorkflowInstanceStatus = 'queued' | 'running' | 'paused' | 'errored' | 'terminated' | 'complete' | 'waiting' | 'waitingForPause' | 'unknown'; + export abstract class WorkflowEntrypoint | unknown = unknown> implements Rpc.WorkflowEntrypointBranded { + [Rpc.__WORKFLOW_ENTRYPOINT_BRAND]: never; + protected ctx: ExecutionContext; + protected env: Env; + constructor(ctx: ExecutionContext, env: Env); + run(event: Readonly>, step: WorkflowStep): Promise; + } + export function waitUntil(promise: Promise): void; + export function withEnv(newEnv: unknown, fn: () => unknown): unknown; + export function withExports(newExports: unknown, fn: () => unknown): unknown; + export function withEnvAndExports(newEnv: unknown, newExports: unknown, fn: () => unknown): unknown; + export const env: Cloudflare.Env; + export const exports: Cloudflare.Exports; + export const cache: CacheContext; + export const tracing: Tracing; +} +declare module 'cloudflare:workers' { + export = CloudflareWorkersModule; +} +interface SecretsStoreSecret { + /** + * Get a secret from the Secrets Store, returning a string of the secret value + * if it exists, or throws an error if it does not exist + */ + get(): Promise; +} +declare module "cloudflare:sockets" { + function _connect(address: string | SocketAddress, options?: SocketOptions): Socket; + export { _connect as connect }; +} +/** + * Binding entrypoint for Cloudflare Stream. + * + * Usage: + * - Binding-level operations: + * `await env.STREAM.videos.upload` + * `await env.STREAM.videos.createDirectUpload` + * `await env.STREAM.videos.*` + * `await env.STREAM.watermarks.*` + * - Per-video operations: + * `await env.STREAM.video(id).downloads.*` + * `await env.STREAM.video(id).captions.*` + * + * Example usage: + * ```ts + * await env.STREAM.video(id).downloads.generate(); + * + * const video = env.STREAM.video(id) + * const captions = video.captions.list(); + * const videoDetails = video.details() + * ``` + */ +interface StreamBinding { + /** + * Returns a handle scoped to a single video for per-video operations. + * @param id The unique identifier for the video. + * @returns A handle for per-video operations. + */ + video(id: string): StreamVideoHandle; + /** + * Uploads a new video from a provided URL. + * @param url The URL to upload from. + * @param params Optional upload parameters. + * @returns The uploaded video details. + * @throws {BadRequestError} if the upload parameter is invalid or the URL is invalid + * @throws {QuotaReachedError} if the account storage capacity is exceeded + * @throws {MaxFileSizeError} if the file size is too large + * @throws {RateLimitedError} if the server received too many requests + * @throws {AlreadyUploadedError} if a video was already uploaded to this URL + * @throws {InternalError} if an unexpected error occurs + */ + upload(url: string, params?: StreamUrlUploadParams): Promise; + /** + * Creates a direct upload that allows video uploads without an API key. + * @param params Parameters for the direct upload + * @returns The direct upload details. + * @throws {BadRequestError} if the parameters are invalid + * @throws {RateLimitedError} if the server received too many requests + * @throws {InternalError} if an unexpected error occurs + */ + createDirectUpload(params: StreamDirectUploadCreateParams): Promise; + videos: StreamVideos; + watermarks: StreamWatermarks; +} +/** + * Handle for operations scoped to a single Stream video. + */ +interface StreamVideoHandle { + /** + * The unique identifier for the video. + */ + id: string; + /** + * Get a full videos details + * @returns The full video details. + * @throws {NotFoundError} if the video is not found + * @throws {InternalError} if an unexpected error occurs + */ + details(): Promise; + /** + * Update details for a single video. + * @param params The fields to update for the video. + * @returns The updated video details. + * @throws {NotFoundError} if the video is not found + * @throws {BadRequestError} if the parameters are invalid + * @throws {InternalError} if an unexpected error occurs + */ + update(params: StreamUpdateVideoParams): Promise; + /** + * Deletes a video and its copies from Cloudflare Stream. + * @returns A promise that resolves when deletion completes. + * @throws {NotFoundError} if the video is not found + * @throws {InternalError} if an unexpected error occurs + */ + delete(): Promise; + /** + * Creates a signed URL token for a video. + * @returns The signed token that was created. + * @throws {InternalError} if the signing key cannot be retrieved or the token cannot be signed + */ + generateToken(): Promise; + downloads: StreamScopedDownloads; + captions: StreamScopedCaptions; +} +interface StreamVideo { + /** + * The unique identifier for the video. + */ + id: string; + /** + * A user-defined identifier for the media creator. + */ + creator: string | null; + /** + * The thumbnail URL for the video. + */ + thumbnail: string; + /** + * The thumbnail timestamp percentage. + */ + thumbnailTimestampPct: number; + /** + * Indicates whether the video is ready to stream. + */ + readyToStream: boolean; + /** + * The date and time the video became ready to stream. + */ + readyToStreamAt: string | null; + /** + * Processing status information. + */ + status: StreamVideoStatus; + /** + * A user modifiable key-value store. + */ + meta: Record; + /** + * The date and time the video was created. + */ + created: string; + /** + * The date and time the video was last modified. + */ + modified: string; + /** + * The date and time at which the video will be deleted. + */ + scheduledDeletion: string | null; + /** + * The size of the video in bytes. + */ + size: number; + /** + * The preview URL for the video. + */ + preview?: string; + /** + * Origins allowed to display the video. + */ + allowedOrigins: Array; + /** + * Indicates whether signed URLs are required. + */ + requireSignedURLs: boolean | null; + /** + * The date and time the video was uploaded. + */ + uploaded: string | null; + /** + * The date and time when the upload URL expires. + */ + uploadExpiry: string | null; + /** + * The maximum size in bytes for direct uploads. + */ + maxSizeBytes: number | null; + /** + * The maximum duration in seconds for direct uploads. + */ + maxDurationSeconds: number | null; + /** + * The video duration in seconds. -1 indicates unknown. + */ + duration: number; + /** + * Input metadata for the original upload. + */ + input: StreamVideoInput; + /** + * Playback URLs for the video. + */ + hlsPlaybackUrl: string; + dashPlaybackUrl: string; + /** + * The watermark applied to the video, if any. + */ + watermark: StreamWatermark | null; + /** + * The live input id associated with the video, if any. + */ + liveInputId?: string | null; + /** + * The source video id if this is a clip. + */ + clippedFromId: string | null; + /** + * Public details associated with the video. + */ + publicDetails: StreamPublicDetails | null; +} +type StreamVideoStatus = { + /** + * The current processing state. + */ + state: string; + /** + * The current processing step. + */ + step?: string; + /** + * The percent complete as a string. + */ + pctComplete?: string; + /** + * An error reason code, if applicable. + */ + errorReasonCode: string; + /** + * An error reason text, if applicable. + */ + errorReasonText: string; +}; +type StreamVideoInput = { + /** + * The input width in pixels. + */ + width: number; + /** + * The input height in pixels. + */ + height: number; +}; +type StreamPublicDetails = { + /** + * The public title for the video. + */ + title: string | null; + /** + * The public share link. + */ + share_link: string | null; + /** + * The public channel link. + */ + channel_link: string | null; + /** + * The public logo URL. + */ + logo: string | null; +}; +type StreamDirectUpload = { + /** + * The URL an unauthenticated upload can use for a single multipart request. + */ + uploadURL: string; + /** + * A Cloudflare-generated unique identifier for a media item. + */ + id: string; + /** + * The watermark profile applied to the upload. + */ + watermark: StreamWatermark | null; + /** + * The scheduled deletion time, if any. + */ + scheduledDeletion: string | null; +}; +type StreamDirectUploadCreateParams = { + /** + * The maximum duration in seconds for a video upload. + */ + maxDurationSeconds: number; + /** + * The date and time after upload when videos will not be accepted. + */ + expiry?: string; + /** + * A user-defined identifier for the media creator. + */ + creator?: string; + /** + * A user modifiable key-value store used to reference other systems of record for + * managing videos. + */ + meta?: Record; + /** + * Lists the origins allowed to display the video. + */ + allowedOrigins?: Array; + /** + * Indicates whether the video can be accessed using the id. When set to `true`, + * a signed token must be generated with a signing key to view the video. + */ + requireSignedURLs?: boolean; + /** + * The thumbnail timestamp percentage. + */ + thumbnailTimestampPct?: number; + /** + * The date and time at which the video will be deleted. Include `null` to remove + * a scheduled deletion. + */ + scheduledDeletion?: string | null; + /** + * The watermark profile to apply. + */ + watermark?: StreamDirectUploadWatermark; +}; +type StreamDirectUploadWatermark = { + /** + * The unique identifier for the watermark profile. + */ + id: string; +}; +type StreamUrlUploadParams = { + /** + * Lists the origins allowed to display the video. Enter allowed origin + * domains in an array and use `*` for wildcard subdomains. Empty arrays allow the + * video to be viewed on any origin. + */ + allowedOrigins?: Array; + /** + * A user-defined identifier for the media creator. + */ + creator?: string; + /** + * A user modifiable key-value store used to reference other systems of + * record for managing videos. + */ + meta?: Record; + /** + * Indicates whether the video can be a accessed using the id. When + * set to `true`, a signed token must be generated with a signing key to view the + * video. + */ + requireSignedURLs?: boolean; + /** + * Indicates the date and time at which the video will be deleted. Omit + * the field to indicate no change, or include with a `null` value to remove an + * existing scheduled deletion. If specified, must be at least 30 days from upload + * time. + */ + scheduledDeletion?: string | null; + /** + * The timestamp for a thumbnail image calculated as a percentage value + * of the video's duration. To convert from a second-wise timestamp to a + * percentage, divide the desired timestamp by the total duration of the video. If + * this value is not set, the default thumbnail image is taken from 0s of the + * video. + */ + thumbnailTimestampPct?: number; + /** + * The identifier for the watermark profile + */ + watermarkId?: string; +}; +interface StreamScopedCaptions { + /** + * Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. + * One caption or subtitle file per language is allowed. + * @param language The BCP 47 language tag for the caption or subtitle. + * @param input The caption or subtitle stream to upload. + * @returns The created caption entry. + * @throws {NotFoundError} if the video is not found + * @throws {BadRequestError} if the language or file is invalid + * @throws {InternalError} if an unexpected error occurs + */ + upload(language: string, input: ReadableStream): Promise; + /** + * Generate captions or subtitles for the provided language via AI. + * @param language The BCP 47 language tag to generate. + * @returns The generated caption entry. + * @throws {NotFoundError} if the video is not found + * @throws {BadRequestError} if the language is invalid + * @throws {StreamError} if a generated caption already exists + * @throws {StreamError} if the video duration is too long + * @throws {StreamError} if the video is missing audio + * @throws {StreamError} if the requested language is not supported + * @throws {InternalError} if an unexpected error occurs + */ + generate(language: string): Promise; + /** + * Lists the captions or subtitles. + * Use the language parameter to filter by a specific language. + * @param language The optional BCP 47 language tag to filter by. + * @returns The list of captions or subtitles. + * @throws {NotFoundError} if the video or caption is not found + * @throws {InternalError} if an unexpected error occurs + */ + list(language?: string): Promise; + /** + * Removes the captions or subtitles from a video. + * @param language The BCP 47 language tag to remove. + * @returns A promise that resolves when deletion completes. + * @throws {NotFoundError} if the video or caption is not found + * @throws {InternalError} if an unexpected error occurs + */ + delete(language: string): Promise; +} +interface StreamScopedDownloads { + /** + * Generates a download for a video when a video is ready to view. Available + * types are `default` and `audio`. Defaults to `default` when omitted. + * @param downloadType The download type to create. + * @returns The current downloads for the video. + * @throws {NotFoundError} if the video is not found + * @throws {BadRequestError} if the download type is invalid + * @throws {StreamError} if the video duration is too long to generate a download + * @throws {StreamError} if the video is not ready to stream + * @throws {InternalError} if an unexpected error occurs + */ + generate(downloadType?: StreamDownloadType): Promise; + /** + * Lists the downloads created for a video. + * @returns The current downloads for the video. + * @throws {NotFoundError} if the video or downloads are not found + * @throws {InternalError} if an unexpected error occurs + */ + get(): Promise; + /** + * Delete the downloads for a video. Available types are `default` and `audio`. + * Defaults to `default` when omitted. + * @param downloadType The download type to delete. + * @returns A promise that resolves when deletion completes. + * @throws {NotFoundError} if the video or downloads are not found + * @throws {InternalError} if an unexpected error occurs + */ + delete(downloadType?: StreamDownloadType): Promise; +} +interface StreamVideos { + /** + * Lists all videos in a users account. + * @returns The list of videos. + * @throws {BadRequestError} if the parameters are invalid + * @throws {InternalError} if an unexpected error occurs + */ + list(params?: StreamVideosListParams): Promise; +} +interface StreamWatermarks { + /** + * Generate a new watermark profile + * @param input The image stream to upload + * @param params The watermark creation parameters. + * @returns The created watermark profile. + * @throws {BadRequestError} if the parameters are invalid + * @throws {InvalidURLError} if the URL is invalid + * @throws {TooManyWatermarksError} if the number of allowed watermarks is reached + * @throws {InternalError} if an unexpected error occurs + */ + generate(input: ReadableStream, params: StreamWatermarkCreateParams): Promise; + /** + * Generate a new watermark profile + * @param url The image url to upload + * @param params The watermark creation parameters. + * @returns The created watermark profile. + * @throws {BadRequestError} if the parameters are invalid + * @throws {InvalidURLError} if the URL is invalid + * @throws {TooManyWatermarksError} if the number of allowed watermarks is reached + * @throws {InternalError} if an unexpected error occurs + */ + generate(url: string, params: StreamWatermarkCreateParams): Promise; + /** + * Lists all watermark profiles for an account. + * @returns The list of watermark profiles. + * @throws {InternalError} if an unexpected error occurs + */ + list(): Promise; + /** + * Retrieves details for a single watermark profile. + * @param watermarkId The watermark profile identifier. + * @returns The watermark profile details. + * @throws {NotFoundError} if the watermark is not found + * @throws {InternalError} if an unexpected error occurs + */ + get(watermarkId: string): Promise; + /** + * Deletes a watermark profile. + * @param watermarkId The watermark profile identifier. + * @returns A promise that resolves when deletion completes. + * @throws {NotFoundError} if the watermark is not found + * @throws {InternalError} if an unexpected error occurs + */ + delete(watermarkId: string): Promise; +} +type StreamUpdateVideoParams = { + /** + * Lists the origins allowed to display the video. Enter allowed origin + * domains in an array and use `*` for wildcard subdomains. Empty arrays allow the + * video to be viewed on any origin. + */ + allowedOrigins?: Array; + /** + * A user-defined identifier for the media creator. + */ + creator?: string; + /** + * The maximum duration in seconds for a video upload. Can be set for a + * video that is not yet uploaded to limit its duration. Uploads that exceed the + * specified duration will fail during processing. A value of `-1` means the value + * is unknown. + */ + maxDurationSeconds?: number; + /** + * A user modifiable key-value store used to reference other systems of + * record for managing videos. + */ + meta?: Record; + /** + * Indicates whether the video can be a accessed using the id. When + * set to `true`, a signed token must be generated with a signing key to view the + * video. + */ + requireSignedURLs?: boolean; + /** + * Indicates the date and time at which the video will be deleted. Omit + * the field to indicate no change, or include with a `null` value to remove an + * existing scheduled deletion. If specified, must be at least 30 days from upload + * time. + */ + scheduledDeletion?: string | null; + /** + * The timestamp for a thumbnail image calculated as a percentage value + * of the video's duration. To convert from a second-wise timestamp to a + * percentage, divide the desired timestamp by the total duration of the video. If + * this value is not set, the default thumbnail image is taken from 0s of the + * video. + */ + thumbnailTimestampPct?: number; +}; +type StreamCaption = { + /** + * Whether the caption was generated via AI. + */ + generated?: boolean; + /** + * The language label displayed in the native language to users. + */ + label: string; + /** + * The language tag in BCP 47 format. + */ + language: string; + /** + * The status of a generated caption. + */ + status?: 'ready' | 'inprogress' | 'error'; +}; +type StreamDownloadStatus = 'ready' | 'inprogress' | 'error'; +type StreamDownloadType = 'default' | 'audio'; +type StreamDownload = { + /** + * Indicates the progress as a percentage between 0 and 100. + */ + percentComplete: number; + /** + * The status of a generated download. + */ + status: StreamDownloadStatus; + /** + * The URL to access the generated download. + */ + url?: string; +}; +/** + * An object with download type keys. Each key is optional and only present if that + * download type has been created. + */ +type StreamDownloadGetResponse = { + /** + * The audio-only download. Only present if this download type has been created. + */ + audio?: StreamDownload; + /** + * The default video download. Only present if this download type has been created. + */ + default?: StreamDownload; +}; +type StreamWatermarkPosition = 'upperRight' | 'upperLeft' | 'lowerLeft' | 'lowerRight' | 'center'; +type StreamWatermark = { + /** + * The unique identifier for a watermark profile. + */ + id: string; + /** + * The size of the image in bytes. + */ + size: number; + /** + * The height of the image in pixels. + */ + height: number; + /** + * The width of the image in pixels. + */ + width: number; + /** + * The date and a time a watermark profile was created. + */ + created: string; + /** + * The source URL for a downloaded image. If the watermark profile was created via + * direct upload, this field is null. + */ + downloadedFrom: string | null; + /** + * A short description of the watermark profile. + */ + name: string; + /** + * The translucency of the image. A value of `0.0` makes the image completely + * transparent, and `1.0` makes the image completely opaque. Note that if the image + * is already semi-transparent, setting this to `1.0` will not make the image + * completely opaque. + */ + opacity: number; + /** + * The whitespace between the adjacent edges (determined by position) of the video + * and the image. `0.0` indicates no padding, and `1.0` indicates a fully padded + * video width or length, as determined by the algorithm. + */ + padding: number; + /** + * The size of the image relative to the overall size of the video. This parameter + * will adapt to horizontal and vertical videos automatically. `0.0` indicates no + * scaling (use the size of the image as-is), and `1.0 `fills the entire video. + */ + scale: number; + /** + * The location of the image. Valid positions are: `upperRight`, `upperLeft`, + * `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the + * `padding` parameter. + */ + position: StreamWatermarkPosition; +}; +type StreamWatermarkCreateParams = { + /** + * A short description of the watermark profile. + */ + name?: string; + /** + * The translucency of the image. A value of `0.0` makes the image completely + * transparent, and `1.0` makes the image completely opaque. Note that if the + * image is already semi-transparent, setting this to `1.0` will not make the + * image completely opaque. + */ + opacity?: number; + /** + * The whitespace between the adjacent edges (determined by position) of the + * video and the image. `0.0` indicates no padding, and `1.0` indicates a fully + * padded video width or length, as determined by the algorithm. + */ + padding?: number; + /** + * The size of the image relative to the overall size of the video. This + * parameter will adapt to horizontal and vertical videos automatically. `0.0` + * indicates no scaling (use the size of the image as-is), and `1.0 `fills the + * entire video. + */ + scale?: number; + /** + * The location of the image. + */ + position?: StreamWatermarkPosition; +}; +type StreamVideosListParams = { + /** + * The maximum number of videos to return. + */ + limit?: number; + /** + * Return videos created before this timestamp. + * (RFC3339/RFC3339Nano) + */ + before?: string; + /** + * Comparison operator for the `before` field. + * @default 'lt' + */ + beforeComp?: StreamPaginationComparison; + /** + * Return videos created after this timestamp. + * (RFC3339/RFC3339Nano) + */ + after?: string; + /** + * Comparison operator for the `after` field. + * @default 'gte' + */ + afterComp?: StreamPaginationComparison; +}; +type StreamPaginationComparison = 'eq' | 'gt' | 'gte' | 'lt' | 'lte'; +/** + * Error object for Stream binding operations. + */ +interface StreamError extends Error { + readonly code: number; + readonly statusCode: number; + readonly message: string; + readonly stack?: string; +} +interface InternalError extends StreamError { + name: 'InternalError'; +} +interface BadRequestError extends StreamError { + name: 'BadRequestError'; +} +interface NotFoundError extends StreamError { + name: 'NotFoundError'; +} +interface ForbiddenError extends StreamError { + name: 'ForbiddenError'; +} +interface RateLimitedError extends StreamError { + name: 'RateLimitedError'; +} +interface QuotaReachedError extends StreamError { + name: 'QuotaReachedError'; +} +interface MaxFileSizeError extends StreamError { + name: 'MaxFileSizeError'; +} +interface InvalidURLError extends StreamError { + name: 'InvalidURLError'; +} +interface AlreadyUploadedError extends StreamError { + name: 'AlreadyUploadedError'; +} +interface TooManyWatermarksError extends StreamError { + name: 'TooManyWatermarksError'; +} +type MarkdownDocument = { + name: string; + blob: Blob; +}; +type ConversionResponse = { + id: string; + name: string; + mimeType: string; + format: 'markdown'; + tokens: number; + data: string; +} | { + id: string; + name: string; + mimeType: string; + format: 'error'; + error: string; +}; +type ImageConversionOptions = { + descriptionLanguage?: 'en' | 'es' | 'fr' | 'it' | 'pt' | 'de'; +}; +type EmbeddedImageConversionOptions = ImageConversionOptions & { + convert?: boolean; + maxConvertedImages?: number; +}; +type ConversionOptions = { + html?: { + images?: EmbeddedImageConversionOptions & { + convertOGImage?: boolean; + }; + hostname?: string; + cssSelector?: string; + }; + docx?: { + images?: EmbeddedImageConversionOptions; + }; + image?: ImageConversionOptions; + pdf?: { + images?: EmbeddedImageConversionOptions; + metadata?: boolean; + }; +}; +type ConversionRequestOptions = { + gateway?: GatewayOptions; + extraHeaders?: object; + conversionOptions?: ConversionOptions; +}; +type SupportedFileFormat = { + mimeType: string; + extension: string; +}; +declare abstract class ToMarkdownService { + transform(files: MarkdownDocument[], options?: ConversionRequestOptions): Promise; + transform(files: MarkdownDocument, options?: ConversionRequestOptions): Promise; + supported(): Promise; +} +declare namespace TailStream { + interface Header { + readonly name: string; + readonly value: string; + } + interface FetchEventInfo { + readonly type: "fetch"; + readonly method: string; + readonly url: string; + readonly cfJson?: object; + readonly headers: Header[]; + } + interface JsRpcEventInfo { + readonly type: "jsrpc"; + } + interface ScheduledEventInfo { + readonly type: "scheduled"; + readonly scheduledTime: Date; + readonly cron: string; + } + interface AlarmEventInfo { + readonly type: "alarm"; + readonly scheduledTime: Date; + } + interface QueueEventInfo { + readonly type: "queue"; + readonly queueName: string; + readonly batchSize: number; + } + interface EmailEventInfo { + readonly type: "email"; + readonly mailFrom: string; + readonly rcptTo: string; + readonly rawSize: number; + } + interface TraceEventInfo { + readonly type: "trace"; + readonly traces: (string | null)[]; + } + interface HibernatableWebSocketEventInfoMessage { + readonly type: "message"; + } + interface HibernatableWebSocketEventInfoError { + readonly type: "error"; + } + interface HibernatableWebSocketEventInfoClose { + readonly type: "close"; + readonly code: number; + readonly wasClean: boolean; + } + interface HibernatableWebSocketEventInfo { + readonly type: "hibernatableWebSocket"; + readonly info: HibernatableWebSocketEventInfoClose | HibernatableWebSocketEventInfoError | HibernatableWebSocketEventInfoMessage; + } + interface CustomEventInfo { + readonly type: "custom"; + } + interface FetchResponseInfo { + readonly type: "fetch"; + readonly statusCode: number; + } + interface ConnectEventInfo { + readonly type: "connect"; + } + type EventOutcome = "ok" | "canceled" | "exception" | "unknown" | "killSwitch" | "daemonDown" | "exceededCpu" | "exceededMemory" | "loadShed" | "responseStreamDisconnected" | "scriptNotFound" | "internalError"; + interface ScriptVersion { + readonly id: string; + readonly tag?: string; + readonly message?: string; + } + interface TracePreviewInfo { + readonly id: string; + readonly slug: string; + readonly name: string; + } + interface Onset { + readonly type: "onset"; + readonly attributes: Attribute[]; + // id for the span being opened by this Onset event. + readonly spanId: string; + readonly dispatchNamespace?: string; + readonly entrypoint?: string; + readonly executionModel: string; + readonly scriptName?: string; + readonly scriptTags?: string[]; + readonly scriptVersion?: ScriptVersion; + readonly preview?: TracePreviewInfo; + readonly info: FetchEventInfo | ConnectEventInfo | JsRpcEventInfo | ScheduledEventInfo | AlarmEventInfo | QueueEventInfo | EmailEventInfo | TraceEventInfo | HibernatableWebSocketEventInfo | CustomEventInfo; + } + interface Outcome { + readonly type: "outcome"; + readonly outcome: EventOutcome; + readonly cpuTime: number; + readonly wallTime: number; + } + interface SpanOpen { + readonly type: "spanOpen"; + readonly name: string; + // id for the span being opened by this SpanOpen event. + readonly spanId: string; + readonly info?: FetchEventInfo | JsRpcEventInfo | Attributes; + } + interface SpanClose { + readonly type: "spanClose"; + readonly outcome: EventOutcome; + } + interface DiagnosticChannelEvent { + readonly type: "diagnosticChannel"; + readonly channel: string; + readonly message: any; + } + interface Exception { + readonly type: "exception"; + readonly name: string; + readonly message: string; + readonly stack?: string; + } + interface Log { + readonly type: "log"; + readonly level: "debug" | "error" | "info" | "log" | "warn"; + readonly message: object; + } + interface DroppedEventsDiagnostic { + readonly diagnosticsType: "droppedEvents"; + readonly count: number; + } + interface StreamDiagnostic { + readonly type: 'streamDiagnostic'; + // To add new diagnostic types, define a new interface and add it to this union type. + readonly diagnostic: DroppedEventsDiagnostic; + } + // This marks the worker handler return information. + // This is separate from Outcome because the worker invocation can live for a long time after + // returning. For example - Websockets that return an http upgrade response but then continue + // streaming information or SSE http connections. + interface Return { + readonly type: "return"; + readonly info?: FetchResponseInfo; + } + interface Attribute { + readonly name: string; + readonly value: string | string[] | boolean | boolean[] | number | number[] | bigint | bigint[]; + } + interface Attributes { + readonly type: "attributes"; + readonly info: Attribute[]; + } + type EventType = Onset | Outcome | SpanOpen | SpanClose | DiagnosticChannelEvent | Exception | Log | StreamDiagnostic | Return | Attributes; + // Context in which this trace event lives. + interface SpanContext { + // Single id for the entire top-level invocation + // This should be a new traceId for the first worker stage invoked in the eyeball request and then + // same-account service-bindings should reuse the same traceId but cross-account service-bindings + // should use a new traceId. + readonly traceId: string; + // spanId in which this event is handled + // for Onset and SpanOpen events this would be the parent span id + // for Outcome and SpanClose these this would be the span id of the opening Onset and SpanOpen events + // For Hibernate and Mark this would be the span under which they were emitted. + // spanId is not set ONLY if: + // 1. This is an Onset event + // 2. We are not inheriting any SpanContext. (e.g. this is a cross-account service binding or a new top-level invocation) + readonly spanId?: string; + } + interface TailEvent { + // invocation id of the currently invoked worker stage. + // invocation id will always be unique to every Onset event and will be the same until the Outcome event. + readonly invocationId: string; + // Inherited spanContext for this event. + readonly spanContext: SpanContext; + readonly timestamp: Date; + readonly sequence: number; + readonly event: Event; + } + type TailEventHandler = (event: TailEvent) => void | Promise; + type TailEventHandlerObject = { + outcome?: TailEventHandler; + spanOpen?: TailEventHandler; + spanClose?: TailEventHandler; + diagnosticChannel?: TailEventHandler; + exception?: TailEventHandler; + log?: TailEventHandler; + return?: TailEventHandler; + attributes?: TailEventHandler; + }; + type TailEventHandlerType = TailEventHandler | TailEventHandlerObject; +} +// Copyright (c) 2022-2023 Cloudflare, Inc. +// Licensed under the Apache 2.0 license found in the LICENSE file or at: +// https://opensource.org/licenses/Apache-2.0 +/** + * Data types supported for holding vector metadata. + */ +type VectorizeVectorMetadataValue = string | number | boolean | string[]; +/** + * Additional information to associate with a vector. + */ +type VectorizeVectorMetadata = VectorizeVectorMetadataValue | Record; +type VectorFloatArray = Float32Array | Float64Array; +interface VectorizeError { + code?: number; + error: string; +} +/** + * Comparison logic/operation to use for metadata filtering. + * + * This list is expected to grow as support for more operations are released. + */ +type VectorizeVectorMetadataFilterOp = '$eq' | '$ne' | '$lt' | '$lte' | '$gt' | '$gte'; +type VectorizeVectorMetadataFilterCollectionOp = '$in' | '$nin'; +/** + * Filter criteria for vector metadata used to limit the retrieved query result set. + */ +type VectorizeVectorMetadataFilter = { + [field: string]: Exclude | null | { + [Op in VectorizeVectorMetadataFilterOp]?: Exclude | null; + } | { + [Op in VectorizeVectorMetadataFilterCollectionOp]?: Exclude[]; + }; +}; +/** + * Supported distance metrics for an index. + * Distance metrics determine how other "similar" vectors are determined. + */ +type VectorizeDistanceMetric = "euclidean" | "cosine" | "dot-product"; +/** + * Metadata return levels for a Vectorize query. + * + * Default to "none". + * + * @property all Full metadata for the vector return set, including all fields (including those un-indexed) without truncation. This is a more expensive retrieval, as it requires additional fetching & reading of un-indexed data. + * @property indexed Return all metadata fields configured for indexing in the vector return set. This level of retrieval is "free" in that no additional overhead is incurred returning this data. However, note that indexed metadata is subject to truncation (especially for larger strings). + * @property none No indexed metadata will be returned. + */ +type VectorizeMetadataRetrievalLevel = "all" | "indexed" | "none"; +interface VectorizeQueryOptions { + topK?: number; + namespace?: string; + returnValues?: boolean; + returnMetadata?: boolean | VectorizeMetadataRetrievalLevel; + filter?: VectorizeVectorMetadataFilter; +} +/** + * Information about the configuration of an index. + */ +type VectorizeIndexConfig = { + dimensions: number; + metric: VectorizeDistanceMetric; +} | { + preset: string; // keep this generic, as we'll be adding more presets in the future and this is only in a read capacity +}; +/** + * Metadata about an existing index. + * + * This type is exclusively for the Vectorize **beta** and will be deprecated once Vectorize RC is released. + * See {@link VectorizeIndexInfo} for its post-beta equivalent. + */ +interface VectorizeIndexDetails { + /** The unique ID of the index */ + readonly id: string; + /** The name of the index. */ + name: string; + /** (optional) A human readable description for the index. */ + description?: string; + /** The index configuration, including the dimension size and distance metric. */ + config: VectorizeIndexConfig; + /** The number of records containing vectors within the index. */ + vectorsCount: number; +} +/** + * Metadata about an existing index. + */ +interface VectorizeIndexInfo { + /** The number of records containing vectors within the index. */ + vectorCount: number; + /** Number of dimensions the index has been configured for. */ + dimensions: number; + /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */ + processedUpToDatetime: number; + /** UUIDv4 of the last mutation processed by the index. All changes before this mutation will be reflected in the index state. */ + processedUpToMutation: number; +} +/** + * Represents a single vector value set along with its associated metadata. + */ +interface VectorizeVector { + /** The ID for the vector. This can be user-defined, and must be unique. It should uniquely identify the object, and is best set based on the ID of what the vector represents. */ + id: string; + /** The vector values */ + values: VectorFloatArray | number[]; + /** The namespace this vector belongs to. */ + namespace?: string; + /** Metadata associated with the vector. Includes the values of other fields and potentially additional details. */ + metadata?: Record; +} +/** + * Represents a matched vector for a query along with its score and (if specified) the matching vector information. + */ +type VectorizeMatch = Pick, "values"> & Omit & { + /** The score or rank for similarity, when returned as a result */ + score: number; +}; +/** + * A set of matching {@link VectorizeMatch} for a particular query. + */ +interface VectorizeMatches { + matches: VectorizeMatch[]; + count: number; +} +/** + * Results of an operation that performed a mutation on a set of vectors. + * Here, `ids` is a list of vectors that were successfully processed. + * + * This type is exclusively for the Vectorize **beta** and will be deprecated once Vectorize RC is released. + * See {@link VectorizeAsyncMutation} for its post-beta equivalent. + */ +interface VectorizeVectorMutation { + /* List of ids of vectors that were successfully processed. */ + ids: string[]; + /* Total count of the number of processed vectors. */ + count: number; +} +/** + * Result type indicating a mutation on the Vectorize Index. + * Actual mutations are processed async where the `mutationId` is the unique identifier for the operation. + */ +interface VectorizeAsyncMutation { + /** The unique identifier for the async mutation operation containing the changeset. */ + mutationId: string; +} +/** + * A Vectorize Vector Search Index for querying vectors/embeddings. + * + * This type is exclusively for the Vectorize **beta** and will be deprecated once Vectorize RC is released. + * See {@link Vectorize} for its new implementation. + */ +declare abstract class VectorizeIndex { + /** + * Get information about the currently bound index. + * @returns A promise that resolves with information about the current index. + */ + public describe(): Promise; + /** + * Use the provided vector to perform a similarity search across the index. + * @param vector Input vector that will be used to drive the similarity search. + * @param options Configuration options to massage the returned data. + * @returns A promise that resolves with matched and scored vectors. + */ + public query(vector: VectorFloatArray | number[], options?: VectorizeQueryOptions): Promise; + /** + * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown. + * @param vectors List of vectors that will be inserted. + * @returns A promise that resolves with the ids & count of records that were successfully processed. + */ + public insert(vectors: VectorizeVector[]): Promise; + /** + * Upsert a list of vectors into the index dataset. If a provided id exists, it will be replaced with the new values. + * @param vectors List of vectors that will be upserted. + * @returns A promise that resolves with the ids & count of records that were successfully processed. + */ + public upsert(vectors: VectorizeVector[]): Promise; + /** + * Delete a list of vectors with a matching id. + * @param ids List of vector ids that should be deleted. + * @returns A promise that resolves with the ids & count of records that were successfully processed (and thus deleted). + */ + public deleteByIds(ids: string[]): Promise; + /** + * Get a list of vectors with a matching id. + * @param ids List of vector ids that should be returned. + * @returns A promise that resolves with the raw unscored vectors matching the id set. + */ + public getByIds(ids: string[]): Promise; +} +/** + * A Vectorize Vector Search Index for querying vectors/embeddings. + * + * Mutations in this version are async, returning a mutation id. + */ +declare abstract class Vectorize { + /** + * Get information about the currently bound index. + * @returns A promise that resolves with information about the current index. + */ + public describe(): Promise; + /** + * Use the provided vector to perform a similarity search across the index. + * @param vector Input vector that will be used to drive the similarity search. + * @param options Configuration options to massage the returned data. + * @returns A promise that resolves with matched and scored vectors. + */ + public query(vector: VectorFloatArray | number[], options?: VectorizeQueryOptions): Promise; + /** + * Use the provided vector-id to perform a similarity search across the index. + * @param vectorId Id for a vector in the index against which the index should be queried. + * @param options Configuration options to massage the returned data. + * @returns A promise that resolves with matched and scored vectors. + */ + public queryById(vectorId: string, options?: VectorizeQueryOptions): Promise; + /** + * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown. + * @param vectors List of vectors that will be inserted. + * @returns A promise that resolves with a unique identifier of a mutation containing the insert changeset. + */ + public insert(vectors: VectorizeVector[]): Promise; + /** + * Upsert a list of vectors into the index dataset. If a provided id exists, it will be replaced with the new values. + * @param vectors List of vectors that will be upserted. + * @returns A promise that resolves with a unique identifier of a mutation containing the upsert changeset. + */ + public upsert(vectors: VectorizeVector[]): Promise; + /** + * Delete a list of vectors with a matching id. + * @param ids List of vector ids that should be deleted. + * @returns A promise that resolves with a unique identifier of a mutation containing the delete changeset. + */ + public deleteByIds(ids: string[]): Promise; + /** + * Get a list of vectors with a matching id. + * @param ids List of vector ids that should be returned. + * @returns A promise that resolves with the raw unscored vectors matching the id set. + */ + public getByIds(ids: string[]): Promise; +} +/** + * The interface for "version_metadata" binding + * providing metadata about the Worker Version using this binding. + */ +type WorkerVersionMetadata = { + /** The ID of the Worker Version using this binding */ + id: string; + /** The tag of the Worker Version using this binding */ + tag: string; + /** The timestamp of when the Worker Version was uploaded */ + timestamp: string; +}; +interface DynamicDispatchLimits { + /** + * Limit CPU time in milliseconds. + */ + cpuMs?: number; + /** + * Limit number of subrequests. + */ + subRequests?: number; +} +interface DynamicDispatchOptions { + /** + * Limit resources of invoked Worker script. + */ + limits?: DynamicDispatchLimits; + /** + * Arguments for outbound Worker script, if configured. + */ + outbound?: { + [key: string]: any; + }; +} +interface DispatchNamespace { + /** + * @param name Name of the Worker script. + * @param args Arguments to Worker script. + * @param options Options for Dynamic Dispatch invocation. + * @returns A Fetcher object that allows you to send requests to the Worker script. + * @throws If the Worker script does not exist in this dispatch namespace, an error will be thrown. + */ + get(name: string, args?: { + [key: string]: any; + }, options?: DynamicDispatchOptions): Fetcher; +} +declare module 'cloudflare:workflows' { + /** + * NonRetryableError allows for a user to throw a fatal error + * that makes a Workflow instance fail immediately without triggering a retry + */ + export class NonRetryableError extends Error { + public constructor(message: string, name?: string); + } +} +declare abstract class Workflow { + /** + * Get a handle to an existing instance of the Workflow. + * @param id Id for the instance of this Workflow + * @returns A promise that resolves with a handle for the Instance + */ + public get(id: string): Promise; + /** + * Create a new instance and return a handle to it. If a provided id exists, an error will be thrown. + * @param options Options when creating an instance including id and params + * @returns A promise that resolves with a handle for the Instance + */ + public create(options?: WorkflowInstanceCreateOptions): Promise; + /** + * Create a batch of instances and return handle for all of them. If a provided id exists, an error will be thrown. + * `createBatch` is limited at 100 instances at a time or when the RPC limit for the batch (1MiB) is reached. + * @param batch List of Options when creating an instance including name and params + * @returns A promise that resolves with a list of handles for the created instances. + */ + public createBatch(batch: WorkflowInstanceCreateOptions[]): Promise; +} +type WorkflowDurationLabel = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'; +type WorkflowSleepDuration = `${number} ${WorkflowDurationLabel}${'s' | ''}` | number; +type WorkflowRetentionDuration = WorkflowSleepDuration; +interface WorkflowInstanceCreateOptions { + /** + * An id for your Workflow instance. Must be unique within the Workflow. + */ + id?: string; + /** + * The event payload the Workflow instance is triggered with + */ + params?: PARAMS; + /** + * The retention policy for Workflow instance. + * Defaults to the maximum retention period available for the owner's account. + */ + retention?: { + successRetention?: WorkflowRetentionDuration; + errorRetention?: WorkflowRetentionDuration; + }; +} +type InstanceStatus = { + status: 'queued' // means that instance is waiting to be started (see concurrency limits) + | 'running' | 'paused' | 'errored' | 'terminated' // user terminated the instance while it was running + | 'complete' | 'waiting' // instance is hibernating and waiting for sleep or event to finish + | 'waitingForPause' // instance is finishing the current work to pause + | 'unknown'; + error?: { + name: string; + message: string; + }; + output?: unknown; +}; +interface WorkflowError { + code?: number; + message: string; +} +declare abstract class WorkflowInstance { + public id: string; + /** + * Pause the instance. + */ + public pause(): Promise; + /** + * Resume the instance. If it is already running, an error will be thrown. + */ + public resume(): Promise; + /** + * Terminate the instance. If it is errored, terminated or complete, an error will be thrown. + */ + public terminate(): Promise; + /** + * Restart the instance. + */ + public restart(): Promise; + /** + * Returns the current status of the instance. + */ + public status(): Promise; + /** + * Send an event to this instance. + */ + public sendEvent({ type, payload, }: { + type: string; + payload: unknown; + }): Promise; +} diff --git a/cloudflare/edge-api/wrangler.jsonc b/cloudflare/edge-api/wrangler.jsonc new file mode 100644 index 0000000000..b45e10668c --- /dev/null +++ b/cloudflare/edge-api/wrangler.jsonc @@ -0,0 +1,61 @@ +/** + * For more details on how to configure Wrangler, refer to: + * https://developers.cloudflare.com/workers/wrangler/configuration/ + */ +{ + "$schema": "node_modules/wrangler/config-schema.json", + "name": "edge-api", + "main": "src/index.ts", + "compatibility_date": "2026-05-09", + "observability": { + "enabled": true + }, + "upload_source_maps": true, + "compatibility_flags": [ + "nodejs_compat" + ], + "kv_namespaces": [ + { + "binding": "COUNTER_KV", + "id": "e4ba4a6ed0f9491294fd7f4fde51eb7f" + }, + ], + "vars": { + "APP_NAME": "my-edge-api-app", + "COURSE_NAME": "devops-core", + }, + "secrets": { + "required": [ + "API_TOKEN", + "ADMIN_EMAIL" + ], + }, + /** + * Smart Placement + * https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement + */ + // "placement": { "mode": "smart" } + /** + * Bindings + * Bindings allow your Worker to interact with resources on the Cloudflare Developer Platform, including + * databases, object storage, AI inference, real-time communication and more. + * https://developers.cloudflare.com/workers/runtime-apis/bindings/ + */ + /** + * Environment Variables + * https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables + * Note: Use secrets to store sensitive data. + * https://developers.cloudflare.com/workers/configuration/secrets/ + */ + // "vars": { "MY_VARIABLE": "production_value" } + /** + * Static Assets + * https://developers.cloudflare.com/workers/static-assets/binding/ + */ + // "assets": { "directory": "./public/", "binding": "ASSETS" } + /** + * Service Bindings (communicate between multiple Workers) + * https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings + */ + // "services": [ { "binding": "MY_SERVICE", "service": "my-service" } ] +} \ No newline at end of file diff --git a/data/visits b/data/visits new file mode 100644 index 0000000000..d8263ee986 --- /dev/null +++ b/data/visits @@ -0,0 +1 @@ +2 \ No newline at end of file diff --git a/labs/.DS_Store b/labs/.DS_Store new file mode 100644 index 0000000000..6c0065a21b Binary files /dev/null and b/labs/.DS_Store differ diff --git a/labs/lab05.md b/labs/lab05.md index a76d4960aa..16b3febf17 100644 --- a/labs/lab05.md +++ b/labs/lab05.md @@ -94,7 +94,7 @@ ansible/ │ │ │ └── main.yml │ │ └── defaults/ │ │ └── main.yml -│ └── app_deploy/ # Application deployment +│ └── web_app/ # Application deployment │ ├── tasks/ │ │ └── main.yml │ ├── handlers/ @@ -523,7 +523,7 @@ vault_password_file = .vault_pass #### 3.2 Create Application Deployment Role -Create `roles/app_deploy/tasks/main.yml`: +Create `roles/web_app/tasks/main.yml`: **Required Tasks:** 1. Log in to Docker Hub (using vaulted credentials) @@ -538,10 +538,10 @@ Create `roles/app_deploy/tasks/main.yml`: 6. Wait for application to be ready (port check) 7. Verify health endpoint -**Create `roles/app_deploy/handlers/main.yml`:** +**Create `roles/web_app/handlers/main.yml`:** - Handler to restart application container -**Create `roles/app_deploy/defaults/main.yml`:** +**Create `roles/web_app/defaults/main.yml`:** - Default port - Default restart policy - Default environment variables @@ -611,7 +611,7 @@ Create `playbooks/deploy.yml`: become: yes roles: - - app_deploy + - web_app ``` #### 3.4 Run Deployment @@ -652,7 +652,7 @@ Create `ansible/docs/LAB05.md` with these sections: #### 2. Roles Documentation -For each role (common, docker, app_deploy): +For each role (common, docker, web_app): - **Purpose**: What does this role do? - **Variables**: Key variables and defaults - **Handlers**: What handlers are defined? @@ -856,7 +856,7 @@ Ansible has official plugins for major clouds. **Setup & Structure (2 pts):** - [ ] Proper role-based directory structure created -- [ ] All three roles created (common, docker, app_deploy) +- [ ] All three roles created (common, docker, web_app) - [ ] Each role has appropriate tasks, handlers, and defaults - [ ] Ansible.cfg configured correctly - [ ] Inventory configured and connectivity tested @@ -872,7 +872,7 @@ Ansible has official plugins for major clouds. **Application Deployment (2 pts):** - [ ] Ansible Vault used for credentials - [ ] Vault file encrypted (verify with `ansible-vault view`) -- [ ] App_deploy role complete with all required tasks +- [ ] web_app role complete with all required tasks - [ ] Deploy playbook uses role correctly - [ ] Container running with proper configuration - [ ] Health check verification included diff --git a/labs/lab06.md b/labs/lab06.md index c4405cbc47..ea1cd40516 100644 --- a/labs/lab06.md +++ b/labs/lab06.md @@ -167,12 +167,12 @@ ansible-playbook playbooks/provision.yml --tags "docker_install" **Action Required:** ```bash cd ansible/roles -mv app_deploy web_app +mv web_app web_app ``` **Update all references:** -- Playbook imports: `roles/app_deploy` → `roles/web_app` -- Documentation: app_deploy → web_app +- Playbook imports: `roles/web_app` → `roles/web_app` +- Documentation: web_app → web_app - Variable prefixes: Consider `web_app_*` for consistency **Why rename?** @@ -257,7 +257,7 @@ ansible-playbook playbooks/deploy.yml 2. Template docker-compose.yml to the directory 3. Use `docker_compose` module (or `community.docker.docker_compose`) 4. Ensure idempotency (check if already running) -5. Add appropriate tags: `app_deploy`, `compose` +5. Add appropriate tags: `web_app`, `compose` **Deployment Block Pattern:** ```yaml @@ -278,7 +278,7 @@ ansible-playbook playbooks/deploy.yml # Log error, optionally rollback tags: - - app_deploy + - web_app - compose ``` @@ -647,7 +647,7 @@ deploy: echo "${{ secrets.ANSIBLE_VAULT_PASSWORD }}" > /tmp/vault_pass ansible-playbook playbooks/deploy.yml \ --vault-password-file /tmp/vault_pass \ - --tags "app_deploy" + --tags "web_app" rm /tmp/vault_pass ``` diff --git a/lectures/lec5.md b/lectures/lec5.md index 5bcfba6c1a..7b9353c250 100644 --- a/lectures/lec5.md +++ b/lectures/lec5.md @@ -478,7 +478,7 @@ docker_log_max_size: "10m" roles: - common # 📦 Install common packages - docker # 🐳 Install Docker - - app_deploy # 🚀 Deploy application + - web_app # 🚀 Deploy application ``` **🎯 Clean and simple!** @@ -487,7 +487,7 @@ docker_log_max_size: "10m" flowchart LR Playbook[📝 Playbook] --> Common[📦 common] Playbook --> Docker[🐳 docker] - Playbook --> App[🚀 app_deploy] + Playbook --> App[🚀 web_app] Common --> Result[✅ Configured Server] Docker --> Result App --> Result diff --git a/lectures/lec6.md b/lectures/lec6.md index a78ba20b5b..82625b2ab3 100644 --- a/lectures/lec6.md +++ b/lectures/lec6.md @@ -288,7 +288,7 @@ ansible-playbook site.yml --list-tags name: "{{ app_name }}" state: started tags: - - app_deploy + - web_app - deploy - name: Application wipe diff --git a/terraform.tfstate b/terraform.tfstate new file mode 100644 index 0000000000..4317c4f9e2 --- /dev/null +++ b/terraform.tfstate @@ -0,0 +1,9 @@ +{ + "version": 4, + "terraform_version": "1.14.5", + "serial": 1, + "lineage": "a6a25f40-2c4a-c46a-5162-80f3abf7ca66", + "outputs": {}, + "resources": [], + "check_results": null +}