> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# zoe/fastapi-deployment

An orb to test and deploy ZOE FastAPI services to Kubernetes

## Commands

### pull_submodules

Pull Submodules

## Jobs

### test

| Parameter | Type | Default | Description |
|---|---|---|---|
| `dockerhub_user` | string | DOCKER_LOGIN | The name of the env var containing dockerhub user for authenticated pulls |
| `dockerhub_password` | string | DOCKER_PASSWORD | The name of the env var containing dockerhub password for authenticated pulls |

### deploy

| Parameter | Type | Default | Description |
|---|---|---|---|
| `service-name` | string |  | Service name used to deploy to Kubernetes |
| `namespace` | string |  | Kubernetes namespace |
| `cluster-name` | string |  | Kubernetes cluster name |
| `cluster-context` | string |  | Kubernetes cluster context |
| `environment` | string |  | Deployment environment (i.e. Skaffold profile) |
| `pre_deployment_steps` | steps |  | Pre-deployment steps |
| `dockerhub_user` | string | DOCKER_LOGIN | The name of the env var containing dockerhub user for authenticated pulls |
| `dockerhub_password` | string | DOCKER_PASSWORD | The name of the env var containing dockerhub password for authenticated pulls |

## Executors

### python