# Jina Serve

> This section includes the API documentation from the`jina`codebase, as extracted from the`docstrings`_ in the code.

## Pages

- [Api Rst](api-rst.md): ======================
- [Index](cli.md): :octicon:`terminal`Command-Line Interface
- [{fab}`docker` Docker Compose Support](cloud-nativeness-docker-compose.md): (docker-compose)=
- [{fas}`dharmachakra` Kubernetes Support](cloud-nativeness-k8s.md): (kubernetes-docs)=
- [Deploy on Kubernetes](cloud-nativeness-kubernetes.md): (kubernetes)=
- [Prometheus/Grafana Support (Legacy)](cloud-nativeness-monitoring.md): (monitoring)=
- [Migrate from Prometheus/Grafana to OpenTelemetry](cloud-nativeness-opentelemetry-migration.md): (opentelemetry-migration)=
- [{octicon}`telescope-fill` OpenTelemetry Support](cloud-nativeness-opentelemetry.md): (opentelemetry)=
- [Callbacks](concepts-client-callbacks.md): (callback-functions)=
- [{fas}`laptop-code` Client](concepts-client.md): (client)=
- [must match the Flow setup](concepts-client-instrumentation.md): (instrumenting-client)=
- [Rate Limit](concepts-client-rate-limit.md): (client-post-prefetch)=
- [Send GraphQL Mutation](concepts-client-send-graphql-mutation.md): If the Flow is configured with GraphQL endpoint, then you can use Jina-serve {class}`~jina.Client`{meth}`~jina.clien...
- [Send Parameters](concepts-client-send-parameters.md): (client-executor-parameters)=
- [Send & Receive Data](concepts-client-send-receive-data.md): After a {class}`~jina.Client`has connected to a {class}`~jina.Deployment`or a {class}`~jina.Flow`, it can send requ...
- [Third-party clients](concepts-client-third-party-clients.md): (third-party-client)=
- [Transient Errors](concepts-client-transient-errors.md): (transient-errors)=
- [{octicon}`file-code` Configuration](concepts-jcloud-configuration.md): (jcloud-configuration)=
- [Jina AI Cloud Hosting](concepts-jcloud.md): (jcloud)=
- [Add Executors](concepts-orchestration-add-executors.md): (add-executors)=
- [Deployment Args](concepts-orchestration-deployment-args.md): | Name | Description | Type | Default |
- [Deployment](concepts-orchestration-deployment.md): (deployment)=
- [Flow Args](concepts-orchestration-flow-args.md): | Name | Description | Type | Default |
- [Flow](concepts-orchestration-flow.md): (flow-cookbook)=
- [Gateway Args](concepts-orchestration-gateway-args.md): | Name | Description | Type | Default |
- [Handle Exceptions](concepts-orchestration-handle-exceptions.md): (flow-error-handling)=
- [Health Check](concepts-orchestration-health-check.md): Once an Orchestration is running, you can use`jina ping`[CLI](../../api/jina_cli.rst) to run a health check of the ...
- [Hot Reload](concepts-orchestration-hot-reload.md): While developing your Orchestration, you may want it to reload automatically as you change the YAML configuration.
- [{fas}`network-wired` Orchestration](concepts-orchestration.md): (orchestration)=
- [Instrumentation](concepts-orchestration-instrumentation.md): (instrumenting-flow)=
- [Readiness](concepts-orchestration-readiness.md): An Orchestration is marked as "ready", when:
- [Scale Out](concepts-orchestration-scale-out.md): (scale-out)=
- [Troubleshooting on Multiprocessing](concepts-orchestration-troubleshooting-on-multiprocess.md): (multiprocessing-spawn)=
- [{octicon}`file-code` YAML specification](concepts-orchestration-yaml-spec.md): (flow-yaml-spec)=
- [Yaml Vars](concepts-orchestration-yaml-vars.md): Jina-serve Orchestration YAML supports variables and variable substitution according to the [GitHub Actions syntax](h...
- [Coding in Python/YAML](concepts-preliminaries-coding-in-python-yaml.md): (python-yaml)=
- [{fas}`egg` Preliminaries](concepts-preliminaries.md): (architecture-overview)=
- [Add Endpoints](concepts-serving-executor-add-endpoints.md): (exec-endpoint)=
- [Containerize](concepts-serving-executor-containerize.md): (dockerize-exec)=
- [Create](concepts-serving-executor-create.md): (create-executor)=
- [{octicon}`file-code` YAML specification](concepts-serving-executor-deployment-yaml-spec.md): (deployment-yaml-spec)=
- [Dynamic Batching](concepts-serving-executor-dynamic-batching.md): (executor-dynamic-batching)=
- [File Structure](concepts-serving-executor-file-structure.md): (executor-file-structure)=
- [Health Check](concepts-serving-executor-health-check.md): (health-check-microservices)=
- [Hot Reload](concepts-serving-executor-hot-reload.md): (reload-executor)=
- [Create](concepts-serving-executor-hub-create-hub-executor.md): (create-hub-executor)=
- [Debug](concepts-serving-executor-hub-debug-executor.md): (debug-executor)=
- [Portal](concepts-serving-executor-hub-hub-portal.md): Executor Hub is a marketplace for {class}`~jina.Executor`s where you can upload your own Executors or use ones alread...
- [Executor Hub](concepts-serving-executor-hub.md): (jina-hub)=
- [Publish](concepts-serving-executor-hub-push-executor.md): (push-executor)=
- [Use](concepts-serving-executor-hub-use-hub-executor.md): (use-hub-executor)=
- [Executor](concepts-serving-executor.md): (executor-cookbook)=
- [Instrumentation](concepts-serving-executor-instrumentation.md): (instrumenting-executor)=
- [Serve](concepts-serving-executor-serve.md): (serve-executor-standalone)=
- [{octicon}`file-code` YAML specification](concepts-serving-executor-yaml-spec.md): (executor-yaml-spec)=
- [Customization](concepts-serving-gateway-customization.md): (custom-gateway)=
- [Customize HTTP endpoints](concepts-serving-gateway-customize-http-endpoints.md): Not every {class}`~jina.Executor`endpoint will automatically be exposed through the external HTTP interface.
- [Health Check](concepts-serving-gateway-health-check.md): (health-check-gateway)=
- [Gateway](concepts-serving-gateway.md): (gateway)=
- [Rate Limit](concepts-serving-gateway-rate-limit.md): (prefetch)=
- [{octicon}`file-code` YAML specification](concepts-serving-gateway-yaml-spec.md): (gateway-yaml-spec)=
- [{fas}`gears` Serving](concepts-serving.md): (serving)=
- [DocArray support](docarray-support.md): (docarray-support)=
- [{octicon}`list-unordered` Environment Variables](envs.md): (jina-env-vars)=
- [{fas}`folder-plus` Create First Project](get-started-create-app.md): Let's build a toy application with Jina-serve. To start, use Jina-serve CLI to make a new Deployment or a Flow:
- [On Apple Silicon](get-started-install-apple-silicon-m1-m2.md): If you own a macOS device with an Apple Silicon M1/M2 chip, you can run Jina-serve **natively** on it (instead of run...
- [Via Docker Image](get-started-install-docker.md): Our universal Docker image is ready-to-use on linux/amd64 and linux/arm64. The Docker image name always starts with`...
- [Index](get-started-install.md): :hidden:
- [Troubleshooting](get-started-install-troubleshooting.md): This article helps you to solve the installation problems of Jina-serve.
- [On Windows](get-started-install-windows.md): (jina-on-windows)=
- [{octicon}`desktop-download` Install](get-started-install-2.md): (install)=
- [Welcome to Jina-serve!](index.md): :class: tip
- [{octicon}`beaker` Jina AI Cloud](jina-ai-cloud.md): :::::{grid} 2
- [Login & Token Management](jina-ai-cloud-login.md): To use Jina AI Cloud, you need to log in, either via a GitHub or Google account. This section describes how to log in...
- [Protocol Documentation](proto-docs.md): * docarray.proto
- [Index](proto.md): To update`jina`Protobuf:
- [{fas}`tower-cell` Telemetry](telemetry.md): To opt out from telemetry, set the`JINA_OPTOUT_TELEMETRY=1`as an environment variable.
- [Before you start](tutorials-before-you-start.md): (before-start)=
- [Deploy a model](tutorials-deploy-model.md): :class: note
- [Build a GPU Executor](tutorials-gpu-executor.md): (gpu-executor)=
- [Tutorials](tutorials.md): deploy-model
- [Build a Streaming API for a Large Language Model](tutorials-llm-serve.md): :start-after:
- [{octicon}`file-code` YAML Specification](yaml-spec.md): (yaml-spec)=