| name | deploy |
|---|---|
| description | Deploy applications to CreateOS from GitHub repos, Docker images, or file uploads |
User wants to deploy, host, ship, launch, or put an application online.
- Check existing projects:
ListProjectsto avoid duplicates. - Determine deployment type:
- GitHub repo — use
ListConnectedGithubAccounts, thenListGithubRepositoriesto find the repo. Create a VCS project withCreateProject(type: "vcs"). - Docker image — create an image project with
CreateProject(type: "image"), thenCreateDeploymentwith the image reference. - File upload — create an upload project with
CreateProject(type: "upload"), then useUploadDeploymentFilesorUploadDeploymentBase64Files.
- GitHub repo — use
- Create an environment if none exists:
CreateProjectEnvironmentwith resource limits (CPU: 200-500m, Memory: 500-1024MB, Replicas: 1-3). - Set environment variables:
UpdateProjectEnvironmentEnvironmentVariablesfor secrets and config. - Deploy:
CreateDeploymentorTriggerLatestDeployment. - Monitor build:
GetBuildLogsuntil status is "deployed" or "failed". - If failed, inspect logs and retry:
GetDeploymentLogs, thenRetriggerDeployment. - Add a custom domain if needed:
CreateDomain, thenRefreshDomainfor TLS.
- Always check for existing projects before creating new ones.
- Use environment variables for secrets — never hardcode credentials in source.
- Validate project names: 4-32 chars, alphanumeric with hyphens only.
- Confirm destructive operations (delete project/deployment) with the user first.
- Project ID and deployment URL
- Build status and any errors
- Environment configuration summary