[{"_1":2,"_3652":-5,"_3653":-5},"loaderData",{"_3":4,"_737":738},"root",{"_5":6,"_7":8,"_9":10,"_14":15,"_734":735,"_736":-7},"header","\n

\n From the Blog: \n Our Biggest Platform Release in Years: Virtual Providers and\n Virtual Machines\n

\n \n \n \n

\n Platform\n
\n
\n
\n
The Cycle Platform
\n
\n Cycle empowers development and devops teams with\n the tools and foundations needed to simplify,\n standardize, and scale even the most complex of\n platforms.\n
\n
\n
\n \n \n Platform Overview\n \n
\n
\n \n \n Technical Partners\n \n
\n
\n
\n
\n \n Discover The Platform\n
\n \n \n Container Orchestration\n \n
\n \n \n Infrastructure Management\n \n
\n \n \n Effortless Networking\n \n
\n \n \n Integrated Security\n \n

\n \n \n \n \n \n \n

\n\n","footer","\n\n","agent",{"_11":12,"_13":12},"isMobile",false,"isMacOs","articles",[16,23,27,31,35,39,43,47,51,55,59,63,67,69,73,77,81,85,89,93,97,101,105,109,113,117,121,125,129,133,137,141,145,149,153,157,161,163,167,171,175,179,183,187,191,195,199,203,207,211,215,219,223,227,231,235,239,243,247,251,255,259,263,267,271,275,279,283,287,291,295,299,303,307,311,315,319,323,327,331,335,339,343,347,351,355,359,363,367,371,375,379,383,387,391,395,399,403,407,411,415,419,423,427,431,435,439,443,447,451,454,458,462,466,470,474,478,482,486,490,494,498,502,506,510,514,518,522,526,530,534,538,542,546,550,554,558,562,566,570,574,578,582,586,590,594,598,602,606,610,614,618,622,626,630,634,638,642,646,650,654,658,662,666,670,674,678,682,686,690,694,698,702,706,710,714,718,722,726,730],{"_17":18,"_19":20,"_21":22},"title","Configuring a DNS Zone on Cycle","description","Learn how to configure a DNS Zone on the Cycle platform.","path","/getting-started/configuring-a-dns-zone",{"_17":24,"_19":25,"_21":26},"Configuring your Hub on Cycle","Learn how to configure your hub on Cycle Platform.","/getting-started/configuring-a-hub-overview",{"_17":28,"_19":29,"_21":30},"Configuring Ports and Routes on Cycle","Learn how to configure ports and routes on the Cycle platform.","/getting-started/configuring-ports-and-routes",{"_17":32,"_19":33,"_21":34},"Containers 101 on Cycle","Learn the basics of containers on the Cycle platform.","/getting-started/containers-101",{"_17":36,"_19":37,"_21":38},"Creating an Environment on Cycle","Learn how to create an environment on the Cycle platform.","/getting-started/create-an-environment",{"_17":40,"_19":41,"_21":42},"Getting Started on Cycle","Introduction to the Cycle platform.","/getting-started/creating-a-hub",{"_17":44,"_19":45,"_21":46},"Creating a **LINKED** Record on Cycle","Learn how to create a **LINKED** Record on the Cycle platform.","/getting-started/creating-a-linked-record",{"_17":48,"_19":49,"_21":50},"Deploying a Container on Cycle","Learn how to deploy a container on the Cycle platform.","/getting-started/deploying-a-container",{"_17":52,"_19":53,"_21":54},"Deploying a Server on Cycle","Learn how to deploy a server on the Cycle platform.","/getting-started/deploying-a-server",{"_17":56,"_19":57,"_21":58},"Importing an Image on Cycle","Learn how to import an image on the Cycle platform.","/getting-started/importing-an-image",{"_17":60,"_19":61,"_21":62},"Integrating a Provider on Cycle","Learn how to integrate a provider on the Cycle platform.","/getting-started/integrating-with-a-provider",{"_17":64,"_19":65,"_21":66},"Managing a Container on Cycle","Learn how to manage a container on the Cycle platform.","/getting-started/managing-containers",{"_17":40,"_19":41,"_21":68},"/getting-started/overview",{"_17":70,"_19":71,"_21":72},"Cycle Quick Start Guide","Go from a brand new hub to your first container deployed to Cycle.","/getting-started/quick-start",{"_17":74,"_19":75,"_21":76},"Starting a Load Balancer on Cycle","Learn how to start a load balancer on the Cycle platform.","/getting-started/starting-a-load-balancer",{"_17":78,"_19":79,"_21":80},"Technical Support on Cycle","How to get in touch with technical support for the Cycle Platform.","/getting-started/technical-support",{"_17":82,"_19":83,"_21":84},"Acme Challenge NS Records","Giving Cycle permission to create certificates without delegating control of the domain","/guides/acme-challenge-ns-records",{"_17":86,"_19":87,"_21":88},"Automating Backups on Cycle","Learn how to automate backups on Cycle Platform","/guides/automating-backups-overview",{"_17":90,"_19":91,"_21":92},"AWS VPC Peering on Cycle","Learn how to use VPC Peering on AWS through Cycle Platform","/guides/aws-vpc-peering",{"_17":94,"_19":95,"_21":96},"Configure Backblaze for Backups on Cycle","Learn how to configure Backblaze to facilitate backups on Cycle Platform","/guides/backblaze-setup",{"_17":98,"_19":99,"_21":100},"Backup and Restore Commands on Cycle","Learn how to use backup and restore commands on Cycle Platform","/guides/backup-restore-commands",{"_17":102,"_19":103,"_21":104},"Securing Private Network Access with Cloudflare Tunnel","Learn how to configure Cloudflare Tunnel to securely route traffic into an environment without exposing it to the public internet.","/guides/cloudflare-tunnel",{"_17":106,"_19":107,"_21":108},"Configure AWS on Cycle","Learn how to configure AWS as an infrastructure provider on Cycle Platform","/guides/configure-aws",{"_17":110,"_19":111,"_21":112},"Configure Backblaze on Cycle","Learn how to configure Backblaze as an infrastructure provider on Cycle Platform","/guides/configure-backblaze",{"_17":114,"_19":115,"_21":116},"Configure Depot on Cycle","Learn how to configure Depot as an infrastructure provider on Cycle Platform","/guides/configure-depot",{"_17":118,"_19":119,"_21":120},"Configure Equinix Metal on Cycle","Learn how to configure Equinix Metal as an infrastructure provider on Cycle Platform","/guides/configure-equinix-metal",{"_17":122,"_19":123,"_21":124},"Configure Google Cloud Platform (GCP) on Cycle","Learn how to configure Google Cloud Platform (GCP) as an infrastructure provider on Cycle Platform","/guides/configure-gcp",{"_17":126,"_19":127,"_21":128},"Configure Vultr on Cycle","Learn how to configure Vultr as an infrastructure provider on Cycle Platform","/guides/configure-vultr",{"_17":130,"_19":131,"_21":132},"Creating Deployments in the Portal on Cycle","Learn how create deployments on Cycle Platform","/guides/creating-a-deployment-in-the-portal",{"_17":134,"_19":135,"_21":136},"Zero Downtime Deployment on Cycle","Learn how to automate zero downtime deployments on Cycle Platform","/guides/cycle-setup",{"_17":138,"_19":139,"_21":140},"Deploying a Database on Cycle","Learn how to deploy a database on Cycle Platform","/guides/deploying-a-database",{"_17":142,"_19":143,"_21":144},"Using GET Webhooks for Rainbow Deployments on Cycle","Learn how to use GET Webhooks to facilitate rainbow deployments on Cycle Platform","/guides/deployment-get-webhook",{"_17":146,"_19":147,"_21":148},"Using Deployment Health Checks In a Rainbow Deployment on Cycle","Learn how use health checks to facilitate rainbow deployments on Cycle Platform","/guides/deployment-health-checks",{"_17":150,"_19":151,"_21":152},"Shared Filesystems on Cycle","Learn how to configure shared filesystems on Cycle Platform","/guides/shared-filesystems",{"_17":154,"_19":155,"_21":156},"Two-Way Console Tips on Cycle","Learn how use the two-way console on Cycle Platform","/guides/two-way-console-tips",{"_17":158,"_19":159,"_21":160},"GPU Powered Infrastructure on Cycle","Learn how use GPU powered infrastructure on Cycle Platform","/guides/using-gpu-powered-infrastructure",{"_17":134,"_19":135,"_21":162},"/guides/zero-downtime-deployments-overview",{"_17":164,"_19":165,"_21":166},"Access Control Lists","Use Access Control Lists (ACLs) to limit access to specific resources within a hub.","/platform/access-control-lists",{"_17":168,"_19":169,"_21":170},"API Keys","Learn how API keys work and can be generated on the Cycle Platform.","/platform/api-keys",{"_17":172,"_19":173,"_21":174},"Clusters","Partition infrastructure into logical groups, called 'clusters', to isolate network traffic on a physical level between servers.","/platform/clusters",{"_17":176,"_19":177,"_21":178},"Container Backups","Learn how automated backups can be configured for stateful containers on Cycle.","/platform/container-backups",{"_17":180,"_19":181,"_21":182},"Deployment Strategies","Learn about the various deployment","/platform/container-deployment-strategies",{"_17":184,"_19":185,"_21":186},"Environment Variables","How environment variables work with containers running on the Cycle Platform.","/platform/container-environment-variables",{"_17":188,"_19":189,"_21":190},"Container Instances","Learn about container instances on Cycle, including access via the two-way console and cross-cloud migration.","/platform/container-instances",{"_17":192,"_19":193,"_21":194},"Container Logs","Learn how Cycle stores container instance logs for later querying.","/platform/container-logs",{"_17":196,"_19":197,"_21":198},"Container Management","Learn about the management controls the Cycle Platform provides for containers.","/platform/container-management",{"_17":200,"_19":201,"_21":202},"Container Networking","Learn how containers are declaratively networked on the Cycle Platform.","/platform/container-networking",{"_17":204,"_19":205,"_21":206},"Container Resources","Learn how Cycle gives the tooling to manages container resource usage.","/platform/container-resources",{"_17":208,"_19":209,"_21":210},"Container Volumes","Learn how container volumes are managed by Cycle.","/platform/container-volumes",{"_17":212,"_19":213,"_21":214},"Deployments","Learn how to achieve zero-downtime updates by utilizing deployments on Cycle.","/platform/deployments",{"_17":216,"_19":217,"_21":218},"Developer Tooling for Stacks","Discover tools for building Cycle stack files.","/platform/developer-tooling-for-stacks",{"_17":220,"_19":221,"_21":222},"Discovery Service","Learn how Cycle manages service discovery within an environment.","/platform/discovery-service",{"_17":224,"_19":225,"_21":226},"DNS Records","Get to know the various DNS records supported by Cycle, and how they can be used to direct traffic to your applications.","/platform/dns-records",{"_17":228,"_19":229,"_21":230},"DNS Zones","Learn how Cycle handles DNS zones for managing your domains.","/platform/dns-zones",{"_17":232,"_19":233,"_21":234},"Hub Events and Activity","Learn more about hub events and activity.","/platform/events-and-activity",{"_17":236,"_19":237,"_21":238},"Function Containers","Learn how function containers open the doors to task based workloads on the Cycle Platform.","/platform/function-containers",{"_17":240,"_19":241,"_21":242},"Gateway","The gateway service manages public IP allocations for virtual machines within an environment.","/platform/gateway-service",{"_17":244,"_19":245,"_21":246},"Hub Integrations","Hub integrations enable powerful abstractions across infrastructure, storage, image building, and more by utilizing 3rd party tooling.","/platform/hub-integrations",{"_17":248,"_19":249,"_21":250},"Image Source Types","Learn about the different image source types on Cycle.","/platform/image-sources",{"_17":252,"_19":253,"_21":254},"Configure the Infrastructure Abstraction Layer (IAL) on Cycle","Learn how to configure the Infrastructure Abstraction Layer (IAL) on Cycle Platform","/platform/infrastructure-abstraction-layer",{"_17":256,"_19":257,"_21":258},"Introduction to Containers","Become familiar with how containers work on the Cycle Platform.","/platform/introduction-to-containers",{"_17":260,"_19":261,"_21":262},"Introduction to DNS","Learn how DNS functions on the Cycle Platform.","/platform/introduction-to-dns",{"_17":264,"_19":265,"_21":266},"Introduction to Environments","Learn how networking via environments - essentially global VPCs - work on the Cycle Platform.","/platform/introduction-to-environments",{"_17":268,"_19":269,"_21":270},"Introduction to Hubs","Hubs are the central place for collaboration on Cycle. Learn how hubs are used for team organization and management of all resources on the platform.","/platform/introduction-to-hubs",{"_17":272,"_19":273,"_21":274},"Introduction to Images","Learn how container images are managed on the Cycle platform.","/platform/introduction-to-images",{"_17":276,"_19":277,"_21":278},"Introduction to Infrastructure","The Cycle Platform is a paradigm shift for multi and hybrid-cloud infrastructure management. Get to know how Cycle makes global infrastructure easy.","/platform/introduction-to-infrastructure",{"_17":280,"_19":281,"_21":282},"Introduction to Networks (SDNs)","Cycle provides software defined networks (SDNs) for more advanced networking options on top of environments.","/platform/introduction-to-networks",{"_17":284,"_19":285,"_21":286},"Introduction to Pipelines","Learn how to achieve fully automated GitOps using the Cycle Platform","/platform/introduction-to-pipelines",{"_17":288,"_19":289,"_21":290},"Introduction to Stacks","Stacks are a definition file that describe an 'environment as code'. Similar to a Docker Compose file or a Helm chart, stacks define a deployment of multiple containers and their configurations.","/platform/introduction-to-stacks",{"_17":292,"_19":293,"_21":294},"Introduction to Virtual Machines","The Cycle Platform fully supports deploying, running, and orchestrating virtual machines for a higher degree of security and flexibility.","/platform/introduction-to-virtual-machines",{"_17":296,"_19":297,"_21":298},"IP Addresses","Learn how Cycle manages IP addresses across cloud providers.","/platform/ip-addresses",{"_17":300,"_19":301,"_21":302},"Jobs","Learn how Cycle utilizes a job system to manage long-running tasks.","/platform/jobs",{"_17":304,"_19":305,"_21":306},"Load Balancer","Learn about how load balancing is handled on the Cycle platform.","/platform/load-balancer-service",{"_17":308,"_19":309,"_21":310},"Migrating Container Instances","Container instances can easily be migrated between servers, data centers, or even between cloud providers.","/platform/migrating-instances",{"_17":312,"_19":313,"_21":314},"Migrating Virtual Machines","Learn more about managing container instances through the Cycle portal.","/platform/migrating-virtual-machines",{"_17":316,"_19":317,"_21":318},"Native Load Balancer","Cycle's native load balancer is a powerful service for managing environment network traffic and firewalls.","/platform/native-load-balancer",{"_17":320,"_19":321,"_21":322},"Billing and Invoices","Learn more about billing and invoices on Cycle.","/platform/payments-and-invoices",{"_17":324,"_19":325,"_21":326},"Pipeline Steps","Learn about the different steps available when using pipelines on Cycle.","/platform/pipeline-steps",{"_17":328,"_19":329,"_21":330},"Pipeline Trigger Key","Learn how to trigger a pipeline using a trigger key","/platform/pipeline-trigger-keys",{"_17":332,"_19":333,"_21":334},"Pipeline Variables","Create highly dynamic workflows using pipeline variables.","/platform/pipeline-variables",{"_17":336,"_19":337,"_21":338},"Cycle Platform Primitives","The Cycle Platform is built on foundational pieces known as 'primitives'.","/platform/primitives",{"_17":340,"_19":341,"_21":342},"Resource IDs and Identifiers","Every resource in Cycle has an attached ID, and can be referenced using an identifier string.","/platform/resource-ids-and-identifiers",{"_17":344,"_19":345,"_21":346},"Roles and Capabilities","Hubs utilize a role-based access control system for managing resource access for members.","/platform/roles-and-capabilities",{"_17":348,"_19":349,"_21":350},"Scaling and Auto-Scaling","Learn how to scale and auto-scale container instances across nodes, datacenters, and providers.","/platform/scaling-and-auto-scaling",{"_17":352,"_19":353,"_21":354},"Scheduler Service","Learn how the scheduler service is used to manage function containers and batch workloads.","/platform/scheduler-service",{"_17":356,"_19":357,"_21":358},"Scoped Variables","Learn how to use scoped variables to provide configurations and secrets to multiple containers within an environment.","/platform/scoped-variables",{"_17":360,"_19":361,"_21":362},"Servers","Learn how Cycle simplifies the management of servers in multi and hybrid-cloud deployments.","/platform/servers",{"_17":364,"_19":365,"_21":366},"Stack Variables","Learn how to create optimized stacks perfect for GitOps by utilizing stack variables for managing dynamic build parameters.","/platform/stack-variables",{"_17":368,"_19":369,"_21":370},"TLS Certificates","The Cycle Platform can generate and renew TLS certificates automatically. The platform also supports custom user-provided certificates.","/platform/tls-certificates",{"_17":372,"_19":373,"_21":374},"Connecting to Virtual Machines","Connect to virtual machines via the serial SSH console.","/platform/virtual-machine-access",{"_17":376,"_19":377,"_21":378},"Virtual Machine Images","Learn the various types of virtual machine images that are supported by the Cycle Platform.","/platform/virtual-machine-images",{"_17":380,"_19":381,"_21":382},"Virtual Machine Networking","Learn how to route public traffic into virtual machines on Cycle.","/platform/virtual-machine-networking",{"_17":384,"_19":385,"_21":386},"VPN Service","Learn more about the VPN service on Cycle.","/platform/vpn-service",{"_17":388,"_19":389,"_21":390},"Activity and Events in the Portal Audit Log","Learn more about viewing hub activity and events through the audit log in the Cycle portal.","/portal/activity-and-events-in-audit-log",{"_17":392,"_19":393,"_21":394},"Auto-Scale Groups in Portal","Learn more about auto-scale groups and how to interact with them through the Cycle portal.","/portal/auto-scale-groups",{"_17":396,"_19":397,"_21":398},"Billing and Active Services in Portal","Learn more about hub billing and current active services in the Cycle portal.","/portal/billing-dashboard-and-active-services",{"_17":400,"_19":401,"_21":402},"Infrastructure Clusters in Portal","Learn more about managing infrastructure and clusters through the Cycle portal.","/portal/clusters",{"_17":404,"_19":405,"_21":406},"Configuring an HA Proxy Load Balancer in Portal","Learn more about configuring an environment HA Proxy load balancer.","/portal/configuring-ha-proxy",{"_17":408,"_19":409,"_21":410},"Configuring the v1 Load Balancer in Portal","Learn more about configuring the v1 load balancer through the Cycle portal.","/portal/configuring-v1",{"_17":412,"_19":413,"_21":414},"Configuring Web Application Firewall in Portal","Learn more about configuring a web application firewall through the Cycle portal.","/portal/configuring-web-application-firewall",{"_17":416,"_19":417,"_21":418},"Connecting an Image Builder in Portal","Learn more about image builder integrations through the Cycle portal.","/portal/connecting-an-image-builder",{"_17":420,"_19":421,"_21":422},"Connecting an Infrastructure Provider in Portal","Learn more about connecting an infrastructure provider through the Cycle portal.","/portal/connecting-an-infrastructure-provider",{"_17":424,"_19":425,"_21":426},"Connecting Object Storage in Portal","Learn more about connecting object storage through the Cycle portal.","/portal/connecting-object-storage",{"_17":428,"_19":429,"_21":430},"TLS Certificate Hub Integration in Portal","Learn more about viewing the TLS certificate generation hub integration through Cycle portal.","/portal/connecting-tls-certificate-generation",{"_17":432,"_19":433,"_21":434},"Container Auto-Scaling Configuration in Portal","Learn more about container auto-scaling configuration through the Cycle portal.","/portal/container-auto-scaling-configuration",{"_17":436,"_19":437,"_21":438},"Managing Container Backups in Portal","Learn more about managing container backups through the Cycle portal.","/portal/container-backups",{"_17":440,"_19":441,"_21":442},"Container Configuration Overview","Learn more about the container configuration form on the Cycle portal.","/portal/container-configuration-overview",{"_17":444,"_19":445,"_21":446},"Container Dashboard","Learn about the information available on the container dashboard in the portal.","/portal/container-dashboard",{"_17":448,"_19":449,"_21":450},"Container Deployment Configuration in Portal","Learn more about container deployment configuration through the Cycle portal.","/portal/container-deployment-configuration",{"_17":452,"_19":313,"_21":453},"Managing Container Instances in Portal","/portal/container-instances",{"_17":455,"_19":456,"_21":457},"Container Integration Configuration in Portal","Learn more about container integrations through the Cycle portal.","/portal/container-integrations-configuration",{"_17":459,"_19":460,"_21":461},"Container Logs in Portal","Learn more about querying container logs through the Cycle portal.","/portal/container-logs",{"_17":463,"_19":464,"_21":465},"Container Network Configuration in Portal","Learn more about container networking configuration through the Cycle portal.","/portal/container-network-configuration",{"_17":467,"_19":468,"_21":469},"Container Resources Configuration in Portal","Learn more about container resource configuration through the Cycle portal.","/portal/container-resources-configuration",{"_17":471,"_19":472,"_21":473},"Container Runtime Configuration in Portal","Learn more about container runtime configuration through the Cycle portal.","/portal/container-runtime-configuration",{"_17":475,"_19":476,"_21":477},"Managing Container Volumes in Portal","Learn more about managing container volumes through the Cycle portal.","/portal/container-volumes",{"_17":479,"_19":480,"_21":481},"Create a Server in Portal","Learn more about how to create a server through the Cycle portal.","/portal/create-a-server",{"_17":483,"_19":484,"_21":485},"Create a Virtual Machine in the Cycle Portal","Learn how to create a virtual machine in the Cycle portal.","/portal/create-virtual-machine",{"_17":487,"_19":488,"_21":489},"Creating an Container in the Cycle Portal","Learn how to create a container in the Cycle portal.","/portal/creating-a-container",{"_17":491,"_19":492,"_21":493},"Creating a DNS Record in Portal","Learn morea bout creating a DNS record through the Cycle portal.","/portal/creating-a-dns-record",{"_17":495,"_19":496,"_21":497},"Creating a DNS Zone in Portal","Learn more about creating a DNS zone through the Cycle portal.","/portal/creating-a-dns-zone",{"_17":499,"_19":500,"_21":501},"Creating a Pipeline in Portal","Learn more about creating a pipeline through the Cycle portal.","/portal/creating-a-pipeline",{"_17":503,"_19":504,"_21":505},"Creating a Software Defined Network in Portal","Learn more about creating a software defined network through the Cycle portal.","/portal/creating-a-software-defined-network",{"_17":507,"_19":508,"_21":509},"Creating A Stack in Portal","Learn how to create a stack through the Cycle portal.","/portal/creating-a-stack",{"_17":511,"_19":512,"_21":513},"Managing a Pipeline Trigger Key in Portal","Learn how to manage a pipeline trigger key through the Cycle portal.","/portal/creating-a-trigger-key",{"_17":515,"_19":516,"_21":517},"Creating an Environment in the Cycle Portal","Learn about creating a new environment through the Cycle portal.","/portal/creating-an-environment",{"_17":519,"_19":520,"_21":521},"Creating an Image Source in the Cycle Portal","Learn how to create an image source in the Cycle portal.","/portal/creating-an-image-source",{"_17":523,"_19":524,"_21":525},"Viewing the Main Dashboard","Learn more about the main dashboard in the Cycle portal.","/portal/dashboard",{"_17":527,"_19":528,"_21":529},"Deleting an Image or Image Source","Learn how to delete images and image sources in the Cycle portal.","/portal/deleting-an-image-or-image-source",{"_17":531,"_19":532,"_21":533},"Creating Deployments Using Images or Stacks","Learn more about creating new deployments using images or stacks through the Cycle portal.","/portal/deployments-using-images-or-stacks",{"_17":535,"_19":536,"_21":537},"Editing Pipeline Stages and Steps in Portal","Learn more about editing pipeline stages and step through the Cycle portal.","/portal/editing-pipeline-stages-and-steps",{"_17":539,"_19":540,"_21":541},"Environment Containers List in Portal","Learn more about viewing containers on the environment containers list in Cycle portal.","/portal/environment-containers-list",{"_17":543,"_19":544,"_21":545},"Environment Dashboard","Learn more about the environment dashboard in the Cycle portal.","/portal/environment-dashboard",{"_17":547,"_19":548,"_21":549},"Managing Environment Discovery in Portal","Learn more about managing environment discovery service through the Cycle portal.","/portal/environment-discovery",{"_17":551,"_19":552,"_21":553},"Managing the Environment Gateway Service in Portal","Learn more about managing the environment gateway service through the Cycle portal.","/portal/environment-gateway",{"_17":555,"_19":556,"_21":557},"Managing Environment Load Balancers in Portal","Learn more about managing environment load balancers through the Cycle portal.","/portal/environment-load-balancer",{"_17":559,"_19":560,"_21":561},"Managing Environment Scheduler in Portal","Learn more about managing the environment scheduler through the Cycle portal.","/portal/environment-scheduler",{"_17":563,"_19":564,"_21":565},"Environment Scoped Variables in Portal","Learn about managing scoped variables through the Cycle portal.","/portal/environment-scoped-variables",{"_17":567,"_19":568,"_21":569},"Environment Service Instances in the Portal","Learn more about each services instances page in the Cycle portal.","/portal/environment-services-instances",{"_17":571,"_19":572,"_21":573},"Managing Environment VPN in Portal","Learn more about managing environment VPN through the Cycle portal.","/portal/environment-vpn",{"_17":575,"_19":576,"_21":577},"Generating Stack Builds in Portal","Learn how to generate stack builds through the Cycle portal.","/portal/generating-stack-builds",{"_17":579,"_19":580,"_21":581},"Exploring Hub Plans in Portal","Learn more about where and how to explore hub plans through the Cycle portal.","/portal/hub-plans",{"_17":583,"_19":584,"_21":585},"Image Dashboard in Portal","Learn more about the image dashboard in the Cycle portal.","/portal/image-dashboard",{"_17":587,"_19":588,"_21":589},"Images Dashboard in Portal","Learn more about the images dashboard in the Cycle portal.","/portal/images-dashboard",{"_17":591,"_19":592,"_21":593},"Importing Images in the Cycle Portal","Learn how to import images through the Cycle portal.","/portal/importing-images",{"_17":595,"_19":596,"_21":597},"Invoices and Credits in the Portal","Learn more about hub billing invoices and credits in the Cycle portal.","/portal/invoices-and-credits",{"_17":599,"_19":600,"_21":601},"Managing a Container in the Cycle Portal","Learn how to manage an image source in the Cycle portal.","/portal/managing-a-container",{"_17":603,"_19":604,"_21":605},"Managing a Deployment in Portal","Learn more about managing a deployment through the Cycle portal.","/portal/managing-a-deployment",{"_17":607,"_19":608,"_21":609},"Managing a DNS Record in Portal","Learn more about managing a DNS record through the Cycle portal.","/portal/managing-a-dns-record",{"_17":611,"_19":612,"_21":613},"Managing a DNS Zone in Portal","Learn more about managing a DNS zone through the Cycle portal.","/portal/managing-a-dns-zone",{"_17":615,"_19":616,"_21":617},"Managing a Hub and Settings in Portal","Learn more about managing a hub and its settings through the Cycle portal.","/portal/managing-a-hub-and-settings",{"_17":619,"_19":620,"_21":621},"Managing a Pipeline in Portal","Learn more about managing a pipeline through the Cycle portal.","/portal/managing-a-pipeline",{"_17":623,"_19":624,"_21":625},"Managing a Server in Portal","Learn more about managing a server through the Cycle portal.","/portal/managing-a-server",{"_17":627,"_19":628,"_21":629},"Managing a Software Defined Network in Portal","Learn more about managing a software defined network through the Cycle portal.","/portal/managing-a-software-defined-network",{"_17":631,"_19":632,"_21":633},"Managing a Stack","Learn more about managing a stack through the Cycle portal.","/portal/managing-a-stack",{"_17":635,"_19":636,"_21":637},"Managing a Hub Account in Portal","Learn more about account management through the Cycle portal.","/portal/managing-an-account",{"_17":639,"_19":640,"_21":641},"Managing an API Key in Portal","Learn more about managing an API key through the Cycle portal. ","/portal/managing-an-api-key-and-settings",{"_17":643,"_19":644,"_21":645},"Managing an Environment in the Cycle Portal","Learn about managing an environment through the Cycle portal.","/portal/managing-an-environment",{"_17":647,"_19":648,"_21":649},"Managing an Image Source in the Cycle portal","Learn how manage image sources through the Cycle portal.","/portal/managing-an-image-source",{"_17":651,"_19":652,"_21":653},"Managing a Billing Method in Portal","Learn how to manage a hub billing method through the Cycle portal.","/portal/managing-billing-methods",{"_17":655,"_19":656,"_21":657},"Managing Hub Invites in Portal","Learn more about managing hub invites through the Cycle portal.","/portal/managing-hub-invites",{"_17":659,"_19":660,"_21":661},"Managing Hub Members in Portal","Learn more about managing hub members through the Cycle portal.","/portal/managing-hub-members",{"_17":663,"_19":664,"_21":665},"Managing Hub Roles in Portal","Learn more about managing hub roles through the Cycle portal.","/portal/managing-hub-roles",{"_17":667,"_19":668,"_21":669},"Managing IPs","Learn more about managing IPs through the Cycle portal.","/portal/managing-ips",{"_17":671,"_19":672,"_21":673},"Managing Public Network Access","Learn how to manage public network access for virtual machines through the cycle portal.","/portal/managing-public-network-access",{"_17":675,"_19":676,"_21":677},"Managing Stack Builds in Portal","Learn more about managing stack builds in the Cycle portal.","/portal/managing-stack-builds",{"_17":679,"_19":680,"_21":681},"Managing Virtual Machines in Portal","Learn more about managing virtual machine settings through the Cycle portal.","/portal/managing-virtual-machine",{"_17":683,"_19":684,"_21":685},"Server Dashboard in Portal","Learn more about the server dashboard in the Cycle portal.","/portal/servers-dashboard",{"_17":687,"_19":688,"_21":689},"TLS Certificate Log","Learn more about viewing the TLS certificate log in the Cycle portal.","/portal/tls-certificate-log",{"_17":691,"_19":692,"_21":693},"Triggering a Pipeline in Portal","Learn more about triggering pipelines through the Cycle portal.","/portal/triggering-a-pipeline",{"_17":695,"_19":696,"_21":697},"User-Supplied TLS Certificates in the Portal","Learn how to upload user-supplied custom TLS certificates using the Cycle Portal.","/portal/user-supplied-tls-certificates",{"_17":699,"_19":700,"_21":701},"Viewing Pipeline Runs in Portal","Learn more about viewing pipeline runs through the Cycle portal.","/portal/viewing-pipeline-runs",{"_17":703,"_19":704,"_21":705},"Virtual Machine Configuration Overview","Learn more about the virtual machine configuration form on the Cycle portal.","/portal/virtual-machine-configuration-overview",{"_17":707,"_19":708,"_21":709},"Virtual Machine Dashboard in Portal","Learn more about managing virtual machines through the Cycle portal.","/portal/virtual-machine-dashboard",{"_17":711,"_19":712,"_21":713},"Virtual Machine Deployment Configuration in Portal","Learn more about virtual machine deployment configuration through the Cycle portal.","/portal/virtual-machine-deployment",{"_17":715,"_19":716,"_21":717},"View and Manage Virtual Machine Hypervisor in Portal","Learn more about the virtual machine hypervisors and managing them through the Cycle portal.","/portal/virtual-machine-hypervisor",{"_17":719,"_19":720,"_21":721},"Virtual Machine Network Configuration in Portal","Learn more about virtual machine networking configuration through the Cycle portal.","/portal/virtual-machine-network",{"_17":723,"_19":724,"_21":725},"Virtual Machine Resources Configuration in Portal","Learn more about virtual machine resource configuration through the Cycle portal.","/portal/virtual-machine-resources",{"_17":727,"_19":728,"_21":729},"Virtual Machine Telemetry in Portal","Learn more about viewing and managing virtual machine telemetry in the Cycle portal.","/portal/virtual-machine-telemetry",{"_17":731,"_19":732,"_21":733},"Managing Virtual Providers on Cycle","Learn more virtual providers on Cycle. Virtual providers make it effortless to bring any server into your Cycle cluster. Provide basic network details, generate a custom ISO, and boot — the server instantly joins your cluster and connects to Cycle's control plane.","/portal/virtual-providers","aId","14a344c0-96c5-4746-b82e-d50a49c98c95","cookieConsent","routes/platform_.stack-spec",{"_739":740},"spec",{"_741":742,"_17":743,"_19":744,"_745":746,"_747":748,"_751":752},"$schema","https://json-schema.org/draft/2020-12/schema","StackSpec","A Cycle stack file is an \"environment as code\". This allows an environment to be generated consistently based on a fixed specification. \nStack files can describe multiple containers and their configurations, environment service settings, scoped variables, and important metadata.\n","type","object","required",[749,750],"version","containers","properties",{"_749":753,"_759":760,"_780":781,"_750":1027,"_2486":2487,"_2533":2534,"_1369":3646},{"_745":754,"_19":755,"_756":757},"string","The version of the Cycle stack file used.","enum",[758],"1.0","about",{"_761":762},"oneOf",[763,772],{"_745":764,"_747":766,"_751":767},[746,765],"null",[19,749],{"_749":768,"_19":770},{"_745":754,"_19":769},"A custom, user-defined version of the stack.",{"_745":754,"_19":771},"Custom, user-defined details about this stack.",{"_17":773,"_19":774,"_775":776,"_745":754,"_777":778},"StackVariable","A variable specified in a stack spec.","pattern","\\\"?{{(\\$)?([a-z0-9\\-]+)}}\\\"?","examples",[779],"{{$stack-variable}}","scoped_variables",{"_19":782,"_761":783},"Describes variables that are assigned to one or more containers at runtime. Can be assigned as an environment variable, written as a file inside the container(s), or accessed over the internal API.",[784,1026],{"_745":785,"_787":788},[786,765],"array","items",{"_17":789,"_745":746,"_747":790,"_751":794},"StackSpecScopedVariable",[791,792,793],"identifier","scope","access",{"_791":795,"_792":803,"_793":840,"_930":931},{"_761":796},[797,800],{"_17":798,"_745":754,"_19":799},"Identifier","A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.\nThe identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named \"My Container\" will\nhave the identifier of `my-container` and is automatically created by the platform.\n\nThe identifier does not have to be unique.\n",{"_801":802},"$ref","#/properties/about/oneOf/1",{"_761":804},[805,839],{"_745":746,"_747":806,"_751":807},[750],{"_750":808},{"_19":809,"_761":810},"Describes the containers that have access to this scoped variable.",[811,838],{"_745":746,"_747":812,"_751":814},[813],"global",{"_813":815,"_821":822,"_829":830},{"_19":816,"_761":817},"If true, all containers in the environment will have access to this variable.",[818,820],{"_745":819},"boolean",{"_801":802},"ids",{"_19":823,"_761":824},"A list of container IDs that are granted access to this variable.",[825,828],{"_745":826,"_787":827},[786,765],{"_745":754},{"_801":802},"identifiers",{"_19":831,"_761":832},"A list of container identifiers that are granted access to this variable.",[833,837],{"_745":834,"_787":835},[786,765],{"_801":836},"#/properties/scoped_variables/oneOf/0/items/properties/identifier/oneOf/0",{"_801":802},{"_801":802},{"_801":802},{"_761":841},[842,929],{"_745":746,"_751":843},{"_844":845,"_859":860,"_879":880},"env_variable",{"_19":846,"_761":847},"Grants access to this variable from within a container as an environment variable.",[848,857,858],{"_745":746,"_747":849,"_751":851},[850],"key",{"_850":852},{"_19":853,"_761":854},"The environment variable inside the container that stores the value of the variable.",[855,856],{"_745":754},{"_801":802},{"_801":802},{"_745":765},"internal_api",{"_19":861,"_761":862},"Grants access to this variable over the Internal API.",[863,878],{"_745":864,"_751":865},[746,765],{"_866":867},"duration",{"_19":868,"_869":870},"Sets the duration that this variable can be accessed over the Internal API, after container start. Provides additional security as sensitive data can only be accessed for a limited time.","anyOf",[871,876,877],{"_17":872,"_745":754,"_19":873,"_777":874},"Duration","A string signifying a duration of time. Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\", \"d\", \"w\", \"y\".",[875],"72h45m2s",{"_801":802},{"_745":765},{"_801":802},"file",{"_19":881,"_761":882},"Grants access to this variable as a file inside the container.",[883,928],{"_745":884,"_747":885,"_751":887},[746,765],[886,21],"decode",{"_886":888,"_21":893,"_901":902,"_910":911,"_920":921},{"_19":889,"_761":890},"When true, Cycle will interpret this variable as a base-64 encoded string, and decode it before writing it to the file inside the container.",[891,892],{"_745":819},{"_801":802},{"_19":894,"_761":895,"_777":899},"The absolute path to write the variable to (including file name). If `null`, it will be written to `/var/run/cycle/variables/{variable-identifier}`.",[896,898],{"_745":897},[754,765],{"_801":802},[900],"/var/run/cycle/variables/","permissions",{"_761":903,"_19":907,"_777":908},[904,906],{"_745":905},[754,765],{"_801":802},"A linux file mode that will be set on the injected file.",[909],"0644","uid",{"_761":912,"_19":917,"_777":918},[913,916],{"_745":914},[915,765],"integer",{"_801":802},"The linux UID to set on the file.",[919],777,"gid",{"_761":922,"_19":926,"_777":927},[923,925],{"_745":924},[915,765],{"_801":802},"The linux GID to set on the file.",[919],{"_801":802},{"_801":802},"source",{"_869":932},[933,1024,1025],{"_745":746,"_19":934,"_935":936,"_761":944},"Describes the source/value of the variable.\n- **raw**: Directly set the value of the variable in the stack. - **url**: Cycle will fetch the variable content from a remote source when the container starts.\n","discriminator",{"_937":745,"_938":939},"propertyName","mapping",{"_940":941,"_942":943},"url","./StackSpecScopedVariableUrlSource.yml","raw","./StackSpecScopedVariableRawSource.yml",[945,980],{"_17":946,"_745":746,"_19":947,"_747":948,"_751":950},"StackSpecScopedVariableUrlSource","A variable who's value is fetched from a URL when the container starts.",[745,949],"details",{"_745":951,"_949":954},{"_745":754,"_19":952,"_756":953},"The type of scoped variable.",[940],{"_761":955},[956,979],{"_745":746,"_747":957,"_751":960},[940,958,959],"headers","auth_token_url",{"_940":961,"_958":966,"_959":973},{"_19":962,"_761":963},"The URL to call to fetch the value.",[964,965],{"_745":754},{"_801":802},{"_19":967,"_761":968},"Additional headers that can be attached to the URL request. Useful for adding meta-data to third-party services.",[969,972],{"_745":746,"_970":971},"additionalProperties",{},{"_801":802},{"_19":974,"_761":975},"A URL that can be provided to authenticate with a third party secret service. Cycle will make a request to this URL before fetching the secret URL, and use the response as the value of an Authorization header when requesting the secret.",[976,978],{"_745":977},[754,765],{"_801":802},{"_801":802},{"_17":981,"_745":746,"_19":982,"_747":983,"_751":984},"StackSpecScopedVariableRawSource","A variable with a hard-coded value.",[745,949],{"_745":985,"_949":987},{"_19":952,"_745":754,"_756":986},[942],{"_761":988},[989,1023],{"_745":746,"_747":990,"_751":993},[991,992],"value","blob",{"_991":994,"_992":999,"_1004":1005},{"_19":995,"_761":996},"The value of the variable.",[997,998],{"_745":754},{"_801":802},{"_19":1000,"_761":1001},"A boolean where true represents the text the user is entering will be multi line.",[1002,1003],{"_745":819},{"_801":802},"secret",{"_761":1006},[1007,1022],{"_745":1008,"_751":1009},[746,765],{"_1010":1011,"_1016":1017},"iv",{"_19":1012,"_761":1013},"A string describing the IV Hex associated with the encryption of the variable.",[1014,1015],{"_745":754},{"_801":802},"hint",{"_19":1018,"_761":1019},"A user specified hint that will suggest what the encryption key might be",[1020,1021],{"_745":754},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_745":765},{"_801":802},{"_761":1028},[1029,2485],{"_745":746,"_19":1030,"_970":1031},"A mapping of containers that will be deployed as a part of this stack. The key is used as the container's identifier.",{"_17":1032,"_19":1033,"_745":746,"_747":1034,"_751":1039},"StackSpecContainer","A container template defined within a stack.",[1035,1036,1037,1038],"name","image","config","stateful",{"_1035":1040,"_1036":1042,"_1369":1370,"_1038":1377,"_1037":1382,"_2368":2369,"_2374":2375,"_2473":2474,"_2479":2480},{"_745":754,"_19":1041},"The human-readable name of this container.",{"_1043":1044,"_19":1045,"_761":1046},"x-ogen-name","StackSpecContainerImageProperty","Details about the image used for this container.",[1047,1368],{"_17":1048,"_745":746,"_747":1049,"_751":1051},"StackSpecContainerImage",[1050],"origin",{"_1035":1052,"_1050":1058,"_1339":1340,"_1355":1356},{"_19":1053,"_761":1054},"The human-readable name of this image.",[1055,1057],{"_745":1056},[754,765],{"_801":802},{"_19":1059,"_761":1060},"Instructions on how to fetch or build this image.",[1061,1338],{"_17":1062,"_745":746,"_19":1063,"_935":1064,"_761":1076},"StackSpecImageOrigin","The origin of the image.",{"_937":745,"_938":1065},{"_1066":1067,"_1068":1069,"_1070":1071,"_1072":1073,"_1074":1075},"docker-hub","../../components/schemas/images/origins/dockerHub/DockerHubOrigin.yml","docker-file","../../components/schemas/images/origins/dockerFile/DockerFileOrigin.yml","docker-registry","../../components/schemas/images/origins/dockerRegistry/DockerRegistryOrigin.yml","oci-registry","../../components/schemas/images/origins/ociRegistry/OciRegistryOrigin.yml","cycle-source","../../components/schemas/images/origins/cycleSource/CycleSourceOrigin.yml",[1077,1102,1215,1241,1321],{"_17":1078,"_745":746,"_19":1079,"_747":1080,"_751":1081},"DockerHubOrigin","An image origin where the image is pulled from DockerHub.",[745,949],{"_745":1082,"_949":1084},{"_745":754,"_756":1083},[1066],{"_745":746,"_747":1085,"_751":1087},[1086],"target",{"_1088":1089,"_1086":1094,"_1096":1097,"_1099":1100},"existing",{"_869":1090},[1091,1093],{"_801":1092},"#/properties/containers/oneOf/0/additionalProperties/properties/image/oneOf/0/properties/origin/oneOf/0/oneOf/2/properties/details/properties/existing",{"_745":765},{"_745":754,"_19":1095},"The DockerHub target string. ex - `mysql:5.7`","username",{"_745":754,"_19":1098},"For authentication, a username.","token",{"_745":754,"_19":1101},"For authentication, a token.",{"_17":1103,"_745":746,"_19":1104,"_747":1105,"_751":1106},"DockerFileOrigin","An image origin where the image is built from a Dockerfile located in a git repository.",[745,949],{"_745":1107,"_949":1109},{"_745":754,"_756":1108},[1068],{"_745":746,"_751":1110},{"_1088":1111,"_1115":1116,"_1188":1189,"_1192":1193,"_1196":1197,"_1144":1200},{"_869":1112},[1113,1114],{"_801":1092},{"_745":765},"repo",{"_869":1117},[1118,1187],{"_17":1119,"_745":746,"_19":1120,"_747":1121,"_751":1122},"RepoSourceType","Information about the repository.",[940],{"_940":1123,"_1125":1126,"_1128":1129,"_1175":1176},{"_745":754,"_19":1124},"The URL of the repository.","branch",{"_745":754,"_19":1127},"An optional branch arguement. Default value is `master`.","auth",{"_869":1130},[1131,1132],{"_745":765},{"_745":746,"_19":1133,"_935":1134,"_761":1140},"Authentication information for the repository.",{"_937":745,"_938":1135},{"_1136":1137,"_1138":1139},"http","../CredentialsHTTP.yml","ssh","../CredentialsSSH.yml",[1141,1157],{"_17":1142,"_745":746,"_747":1143,"_751":1145},"HTTPSourceCredentials",[745,1144],"credentials",{"_745":1146,"_1144":1148},{"_745":754,"_756":1147},[1136],{"_745":746,"_19":1149,"_747":1150,"_751":1152},"Authentication credentails for the Dockerfile image source type when authenticating over HTTP.",[1096,1151],"password",{"_1096":1153,"_1151":1155},{"_745":754,"_19":1154},"For authentication, the username.",{"_745":754,"_19":1156},"For authentication, the password.",{"_17":1158,"_745":746,"_747":1159,"_751":1160},"SSHSourceCredentials",[745,1144],{"_745":1161,"_1144":1163},{"_745":754,"_756":1162},[1138],{"_745":746,"_19":1164,"_747":1165,"_751":1168},"Authentication credentials for the Dockerfile image source type when authenticating with SSH.",[1096,1166,1167],"passphrase","private_key",{"_1096":1169,"_1166":1171,"_1167":1173},{"_745":754,"_19":1170},"The username for the repo service, that is used to authenticate an ssh key.",{"_745":754,"_19":1172},"The passphrase used for the key.",{"_745":754,"_19":1174},"A pem encoded private key.","ref",{"_761":1177},[1178,1186],{"_745":746,"_19":1179,"_747":1180,"_751":1181},"Repository reference information.",[745,991],{"_745":1182,"_991":1184},{"_745":754,"_19":1183},"The type of reference being used.",{"_745":754,"_19":1185},"The value for the given reference type.",{"_745":765},{"_745":765},"targz_url",{"_745":1190,"_19":1191},[754,765],"An endpoint that serves the tar file.","context_dir",{"_745":1194,"_19":1195},[754,765],"The path to the directory to use as the context when building the image.","build_file",{"_745":1198,"_19":1199},[754,765],"The path to the Dockerfile to be used for buiding the image.",{"_869":1201},[1202,1214],{"_17":1203,"_19":1204,"_745":786,"_787":1205},"DockerfileCredentails","An array of credentials objects to be used when authenticating against private images used by the Dockerfile.",{"_745":746,"_19":1206,"_751":1207},"Credentials object used for authentication of indirect resources such as private parent images.",{"_940":1208,"_1096":1210,"_1099":1212},{"_745":754,"_19":1209},"The url the resource is located at.",{"_745":754,"_19":1211},"A username for authentication.",{"_745":754,"_19":1213},"A token for authentication.",{"_745":765},{"_17":1216,"_745":746,"_19":1217,"_747":1218,"_751":1219},"DockerRegistryOrigin","An image origin where the image is pulled from a private Docker registry.",[745,949],{"_745":1220,"_949":1222},{"_745":754,"_756":1221},[1070],{"_745":746,"_747":1223,"_751":1224},[1086,940],{"_1088":1225,"_1086":1233,"_940":1235,"_1096":1237,"_1099":1238,"_1151":1239},{"_17":1226,"_745":746,"_19":1227,"_751":1228},"ExistingSource","In a stack, specifies an image source ID from which Cycle will derive any values not specified in the stack file. This is useful for avoiding direct placement of credentials in a stack file, for example.",{"_1229":1230},"source_id",{"_801":1231,"_19":1232},"#/properties/containers/oneOf/0/additionalProperties/properties/image/oneOf/0/properties/origin/oneOf/0/oneOf/4/properties/details/properties/source_id","The ID of the image source this image should be built from.",{"_745":754,"_19":1234},"The image name on the registry.",{"_745":754,"_19":1236},"The url of the remote registry.",{"_745":754,"_19":1098},{"_745":754,"_19":1101},{"_745":754,"_19":1240},"For authentication, a password.",{"_17":1242,"_745":746,"_19":1243,"_747":1244,"_751":1245},"OciRegistryOrigin","An image origin that pulls images fro an OCI-compatible registry. Also used for provider-native registries, such as AWS ECR.",[745,949],{"_745":1246,"_949":1248},{"_745":754,"_756":1247},[1072],{"_745":746,"_747":1249,"_751":1250},[1086,940],{"_1088":1251,"_1086":1252,"_940":1253,"_1128":1254},{"_801":1092},{"_745":754,"_19":1234},{"_745":754,"_19":1236},{"_761":1255},[1256,1320],{"_17":1257,"_745":746,"_19":1258,"_935":1259,"_761":1267},"RegistryAuth","Authentication details for a third party image registry/source.",{"_937":745,"_938":1260},{"_1261":1262,"_1263":1264,"_1265":1266},"user","RegistryAuthUser.yml","provider","RegistryAuthProvider.yml","webhook","RegistryAuthWebhook.yml",[1268,1279,1309],{"_17":1269,"_19":1270,"_745":746,"_747":1271,"_751":1272},"RegistryAuthUser","User/token based credentials for authentication to a third-party image source.",[745,949],{"_745":1273,"_949":1275},{"_745":754,"_756":1274},[1261],{"_745":746,"_751":1276},{"_1096":1277,"_1099":1278},{"_745":754},{"_745":754},{"_17":1280,"_19":1281,"_745":746,"_747":1282,"_751":1283},"RegistryAuthProvider","Credentials for authentication to a provider-native image registry, such as AWS ECR.",[745,949],{"_745":1284,"_949":1286},{"_745":754,"_756":1285},[1263],{"_745":746,"_747":1287,"_751":1289},[1288,1144],"flavor",{"_1288":1290,"_1144":1293},{"_745":754,"_756":1291},[1292],"ecr",{"_17":1294,"_745":746,"_751":1295},"RegistryAuthProviderCredentials",{"_1296":1297,"_1298":1299,"_1300":1301,"_1004":1302,"_1303":1304,"_1305":1306,"_1037":1307},"region",{"_745":754},"namespace",{"_745":754},"api_key",{"_745":754},{"_745":754},"subscription_id",{"_745":754},"client_id",{"_745":754},{"_745":754,"_19":1308},"A base64'd string of additional configuration options.",{"_17":1310,"_19":1311,"_745":746,"_747":1312,"_751":1313},"RegistryAuthWebhook","Webhook-based authentication to the provided URL. This webhook expects to receive a base-64 string that when decoded is in the format `username:password`",[745,949],{"_745":1314,"_949":1316},{"_745":754,"_756":1315},[1265],{"_745":746,"_747":1317,"_751":1318},[940],{"_940":1319},{"_745":754},{"_745":765},{"_17":1322,"_745":746,"_19":1323,"_747":1324,"_751":1325},"CycleSourceOrigin","An image origin that references an image source on Cycle. \n\nThis origin will never be embedded in an image source. It is for use in stacks, describing an image which is already a part of an image source on Cycle.\n",[745,949],{"_745":1326,"_949":1328},{"_745":754,"_756":1327},[1074],{"_745":746,"_747":1329,"_751":1330},[1229],{"_1229":1331},{"_19":1332,"_17":1333,"_745":754,"_1334":1335,"_777":1336},"The ID referencing the image source where this image originated.","ID","format","objectid",[1337],"651586fca6078e98982dbd90",{"_801":802},"build",{"_19":1341,"_761":1342},"Additional details applied when building an image.",[1343,1354],{"_745":1344,"_747":1345,"_751":1347},[746,765],[1346],"args",{"_1346":1348},{"_19":1349,"_761":1350},"A map of build arguments applied to the image at build time.",[1351,1353],{"_745":746,"_970":1352},{"_745":754},{"_801":802},{"_801":802},"builder",{"_19":1357,"_761":1358},"A specific builder to use. By default, Cycle uses its factory service and a standard build command to build images, but this can be enhanced by using an image builder integration.",[1359,1367],{"_745":1360,"_747":1361,"_751":1363},[746,765],[1362],"integration_id",{"_1362":1364},{"_19":1365,"_801":1366},"The ID of the integration to use when building the image. The integration must support image building to be compatible.","#/properties/containers/oneOf/0/additionalProperties/properties/config/oneOf/0/properties/integrations/anyOf/0/properties/backups/oneOf/0/properties/integration_id/oneOf/0",{"_801":802},{"_801":802},"annotations",{"_761":1371},[1372,1376],{"_745":1373,"_19":1374,"_970":1375},[746,765],"Additional user-provided meta data about the container.",{},{"_801":802},{"_19":1378,"_761":1379},"Whether or not to mark the container as stateful when deployed. Stateful containers can utilize volumes (stateful data) and are generally used for running databases or other data management applications.",[1380,1381],{"_745":819},{"_801":802},{"_761":1383},[1384,2367],{"_745":746,"_19":1385,"_17":1386,"_747":1387,"_751":1390},"Configuration options for this container that will be applied when deployed as part of the stack.","StackContainerConfig",[1388,1389],"network","deploy",{"_1388":1391,"_1389":1426,"_1712":1713,"_1855":1856,"_2113":2114,"_2166":2167},{"_761":1392},[1393,1425],{"_17":1394,"_1043":1394,"_19":1395,"_745":746,"_747":1396,"_751":1399},"StackSpecContainerConfigNetwork","Stack configuration options related to the container's network.",[1397,1398],"public","hostname",{"_1397":1400,"_1398":1409,"_1414":1415},{"_19":1401,"_761":1402},"The level of public network access this container should have.",[1403,1408],{"_745":754,"_756":1404},[1405,1406,1407],"enable","disable","egress-only",{"_801":802},{"_19":1410,"_761":1411},"The hostname of the container. This is how it can be referenced by other containers in the same environment.",[1412,1413],{"_745":754},{"_801":802},"ports",{"_19":1416,"_761":1417},"A list of port mappings on this container.",[1418,1424],{"_745":786,"_787":1419,"_777":1420},{"_745":754},[1421,1422,1423],"80:80","443:80","3000",{"_801":802},{"_801":802},{"_761":1427},[1428,1711],{"_17":1429,"_745":746,"_19":1430,"_747":1431,"_751":1433},"StackSpecContainerConfigDeploy","Stack configuration options related to how the container behaves over its lifecycle (startup, shutdown, health checks, etc).",[1432],"instances",{"_1432":1434,"_1439":1440,"_1452":1455,"_1038":1491,"_1508":1509,"_1541":1542,"_1572":1573,"_1587":1588,"_1602":1603,"_1632":1633,"_1678":1679},{"_19":1435,"_761":1436},"The number of desired instances to deploy.",[1437,1438],{"_745":915},{"_801":802},"strategy",{"_19":1441,"_761":1442},"The strategy Cycle will apply when deploying instances of this container.\n\n- ** resource-density **: Cycle will distribute instances across servers to maintain balanced resource usage.\n- ** high-availability **: Cycle will deploy instances across servers with an emphasis on geographic and physical separation. Requires multiple locations.\n- ** distributed **: Cycle will deploy instances across servers with an emphasis on physical separation. Does not require multiple locations.\n- ** first-available **: Cycle will deploy one instance to every server that matches the specified criteria. (default)\n- ** node **: Cycle will deploy one instance to every server that matches the specified criteria.\n- ** edge **: Cycle will prioritize geographic distribution of instances.\n- ** function **: Every ingress request/connection receives its own instance. \n- ** manual **: Cycle will not make any decisions on where instances are deployed. Instead, instances must be deployed manually using the portal or API.\n",[1443,1454],{"_745":1444,"_756":1445,"_1453":1449},[754,765],[1446,1447,1448,1449,1450,1451,1452],"resource-density","manual","high-availability","first-available","node","edge","function","default",{"_801":802},{"_19":1456,"_761":1457},"Configuration options for containers using the 'function' deployment strategy.",[1458,1490],{"_745":1459,"_751":1460},[746,765],{"_1461":1462,"_1468":1469,"_1475":1476,"_1483":1484},"max_pool_size",{"_19":1463,"_761":1464},"The maximum number of instances that Cycle can pre-allocate (includes auto-scaled instances).",[1465,1467],{"_745":1466},[915,765],{"_801":802},"max_shard_concurrency",{"_19":1470,"_761":1471},"For each shard (scheduler), the maximum number of tasks it can run in parallel.",[1472,1474],{"_745":1473},[915,765],{"_801":802},"max_runtime",{"_19":1477,"_869":1478},"The maximum amount of time a function instance can run before timing out.",[1479,1481,1482],{"_801":1480},"#/properties/scoped_variables/oneOf/0/items/properties/access/oneOf/0/properties/internal_api/oneOf/0/properties/duration/anyOf/0",{"_801":802},{"_745":765},"max_queue_time",{"_19":1485,"_869":1486},"The maximum amount of time Cycle will wait for an instance to be available.",[1487,1488,1489],{"_801":1480},{"_801":802},{"_745":765},{"_801":802},{"_19":1492,"_761":1493},"Configuration options for stateful containers.",[1494,1507],{"_745":1495,"_747":1496,"_751":1498},[746,765],[1497],"options",{"_1497":1499},{"_19":1500,"_745":1501,"_751":1502},"Stateful container options.",[746,765],{"_1503":1504},"use_base_hostname",{"_19":1505,"_745":1506},"When enabled, instances will utilize stateless base hostnames instead of being prefixed with a unique ID.",[819,765],{"_801":802},"constraints",{"_19":1510,"_761":1511},"Configuration options that provide the ability to set restrictions on which nodes instances of this container are able to be deployed to. (i.e. if you have a GPU container, it should only go on nodes with a GPU).",[1512,1540],{"_745":1513,"_751":1514},[746,765],{"_1450":1515},{"_745":1516,"_747":1517,"_751":1519},[746,765],[1518],"tags",{"_1518":1520},{"_19":1521,"_761":1522},"Tags applied to a node. Cycle generates some automatically, but additional, custom tags can be applied on a per-node basis.",[1523,1539],{"_745":746,"_751":1524},{"_1525":1526,"_1532":1533},"any",{"_19":1527,"_761":1528},"If a node has at least one of these tags, it is considered a valid deployment target for this container.",[1529,1531],{"_745":786,"_787":1530},{"_745":754},{"_801":802},"all",{"_19":1534,"_761":1535},"A node must have **ALL** of these tags to be considered a valid deployment target for this container.",[1536,1538],{"_745":786,"_787":1537},{"_745":754},{"_801":802},{"_801":802},{"_801":802},"shutdown",{"_19":1543,"_761":1544},"Configuration options for how this container behaves during shutdown.",[1545,1571],{"_745":1546,"_751":1547},[746,765],{"_1548":1549,"_1555":1556},"graceful_timeout",{"_19":1550,"_869":1551},"How long the platform will wait for a container to stop gracefully.",[1552,1553,1554],{"_801":1480},{"_801":802},{"_745":765},"signals",{"_761":1557},[1558,1570],{"_745":786,"_19":1559,"_787":1560},"Signals that should be sent to the container on shutdown.",{"_17":1561,"_745":754,"_19":1562,"_756":1563},"ShutdownSignal","Process signals that Cycle can be configured to send to the container on a shutdown event.",[1564,1565,1566,1567,1568,1569],"SIGTERM","SIGINT","SIGUSR1","SIGUSR2","SIGHUP","SIGQUIT",{"_801":802},{"_801":802},"startup",{"_19":1574,"_761":1575},"Configuration options for how this container behaves during startup.",[1576,1586],{"_745":1577,"_751":1578},[746,765],{"_1579":1580},"delay",{"_19":1581,"_869":1582},"How long the platform will wait before sending the start signal to the given container.",[1583,1584,1585],{"_801":1480},{"_801":802},{"_745":765},{"_801":802},"update",{"_19":1589,"_761":1590},"Configurations for how the container behaves during updates.",[1591,1601],{"_745":1592,"_751":1593},[746,765],{"_1594":1595},"stagger",{"_869":1596,"_19":1600},[1597,1598,1599],{"_801":1480},{"_801":802},{"_745":765},"When set, Cycle will pick a random time from `0 - this duration`, and stagger the instances so they all start at different times (up to the time specified here).",{"_801":802},"restart",{"_19":1604,"_761":1605},"Configuration options for how Cycle should handle restarting this container (i.e. in case the process inside the container dies).",[1606,1631],{"_745":1607,"_747":1608,"_751":1611},[746,765],[1609,1579,1610],"condition","max_attempts",{"_1609":1612,"_1579":1621,"_1610":1626},{"_19":1613,"_761":1614},"Under what circumstances Cycle should try to restart this container.",[1615,1620],{"_745":754,"_756":1616},[1617,1618,1619],"always","never","failure",{"_801":802},{"_19":1622,"_761":1623},"How long the platform will wait between restart attempts.",[1624,1625],{"_801":1480},{"_801":802},{"_19":1627,"_761":1628},"The maximum number of restart attempts Cycle will make.",[1629,1630],{"_745":915},{"_801":802},{"_801":802},"health_check",{"_19":1634,"_761":1635},"Configuration options for automated container health checks.",[1636,1677],{"_745":1637,"_747":1638,"_751":1643},[746,765],[1639,1640,1641,1642,1602],"command","retries","interval","timeout",{"_1639":1644,"_1640":1651,"_1641":1656,"_1642":1661,"_1602":1666,"_1579":1671},{"_19":1645,"_761":1646},"The command or script to run to verify the health of the container. This script is run inside the container by Cycle.\nThis command accepts two types of entries:\n- The first is a reference to a script that already lives in the container filesystem. This can be defined by giving the full path to the script as the value. - The second format is an inline script. If you need the code to execute within a shell, wrap the commands in escaped quotes like this `\"\\\"curl -s -o /dev/console -w \\\"%{http_code}\\\" http://localhost:3000/_health | grep '200' && exit 0 || exit 1\\\"\"`. Do not use the `/bin/sh -c ` format, this will not be accepted.\n",[1647,1650],{"_745":754,"_777":1648},[1649],"/bin/sh healthcheck.sh",{"_801":802},{"_19":1652,"_761":1653},"The number of times to retry the command before marking an instance unhealthy.",[1654,1655],{"_745":915},{"_801":802},{"_19":1657,"_761":1658},"How long to wait between running health checks.",[1659,1660],{"_801":1480},{"_801":802},{"_19":1662,"_761":1663},"How long before a health check attempt times out.",[1664,1665],{"_801":1480},{"_801":802},{"_19":1667,"_761":1668},"A boolean where true represents the desire for the container to restart if any instance is unhealthy.",[1669,1670],{"_745":819},{"_801":802},{"_869":1672,"_19":1676},[1673,1674,1675],{"_801":1480},{"_801":802},{"_745":765},"How long to wait after a container start event before running health checks.",{"_801":802},"telemetry",{"_19":1680,"_761":1681},"Configuration options for how the instance telemetry (CPU usage, etc) is handled.",[1682,1710],{"_745":1683,"_747":1684,"_751":1685},[746,765],[1406],{"_1686":1687,"_1641":1693,"_1265":1699,"_1406":1705},"retention",{"_869":1688,"_19":1692},[1689,1690,1691],{"_801":1480},{"_801":802},{"_745":765},"How long telemetry data should be retained.",{"_869":1694,"_19":1698},[1695,1696,1697],{"_801":1480},{"_801":802},{"_745":765},"The duration between samples.",{"_19":1700,"_761":1701},"A URL where Cycle will send telemetry data to. The payload will be an instance resource snapshot.",[1702,1704],{"_745":1703},[754,765],{"_801":802},{"_19":1706,"_761":1707},"If true, Cycle will not aggregate telemetry for this container's instances.",[1708,1709],{"_745":819},{"_801":802},{"_801":802},{"_801":802},"scaling",{"_19":1714,"_869":1715},"Configuration options for auto-scaling.",[1716,1853,1854],{"_17":1717,"_745":746,"_19":1718,"_747":1719,"_751":1723},"StackSpecContainerConfigScaling","Stack configuration options for auto-scaling.",[1720,1432,1721,1722],"autoscale_group","window","thresholds",{"_1720":1724,"_1432":1730,"_1721":1755,"_1722":1760},{"_869":1725,"_19":1729},[1726,1727,1728],{"_801":836},{"_801":802},{"_745":765},"The identifier of the auto-scaling group assigned to this container. The auto-scale group determines which infrastructure this container can spin up if it needs more resources to meet demand. Setting it to `null` will limit auto-scaling to only instances.",{"_761":1731},[1732,1754],{"_745":746,"_19":1733,"_747":1734,"_751":1738},"Describes the criteria for deploying new instances when an auto-scale criteria is met.",[1735,1736,1737],"max","max_server","min_ttl",{"_1735":1739,"_1736":1744,"_1737":1749},{"_19":1740,"_761":1741},"Maximum additional instances the auto-scaler will run at any time.",[1742,1743],{"_745":915},{"_801":802},{"_19":1745,"_761":1746},"Minimum number of instances per server.",[1747,1748],{"_745":915},{"_801":802},{"_19":1750,"_761":1751},"Minimum amount of time an instance will live.",[1752,1753],{"_801":1480},{"_801":802},{"_801":802},{"_19":1756,"_761":1757},"Duration in which the auto-scaler will watch for changes.",[1758,1759],{"_801":1480},{"_801":802},{"_19":1761,"_761":1762},"An array of rules that dictate when a scaling event will be triggered.",[1763,1852],{"_745":786,"_787":1764},{"_17":1765,"_745":746,"_19":1766,"_935":1767,"_761":1781},"StackSpecContainerScaleThreshold","Discriminated union describing the different types of scaling threshold and their respective details",{"_937":745,"_938":1768},{"_1769":1770,"_1771":1772,"_1773":1774,"_1775":1776,"_1777":1778,"_1779":1780},"ram","./StackSpecContainerScaleThresholdRam.yml","cpu","./StackSpecContainerScaleThresholdCpu.yml","custom","./StackSpecContainerScaleThresholdCustom.yml","network-connections","./StackSpecContainerScaleThresholdNetworkConnections.yml","network-requests","./StackSpecContainerScaleThresholdNetworkRequests.yml","network-throughput","./StackSpecContainerScaleThresholdNetworkThroughput.yml",[1782,1798,1810,1822,1834],{"_17":1783,"_745":746,"_19":1784,"_747":1785,"_751":1786},"StackSpecContainerScaleThresholdRam","Describes the RAM threshold at which scaling will occur.",[745,949],{"_745":1787,"_949":1789},{"_745":754,"_756":1788},[1769],{"_745":746,"_747":1790,"_751":1792},[1791],"usage",{"_1791":1793},{"_745":754,"_19":1794,"_777":1795},"The target average RAM usage of all instances of this container. Going above this threshold will trigger a scaling event. This threshold must be greater than 25MB.",[1796,1797],"2G","25MB",{"_17":1799,"_745":746,"_19":1800,"_747":1801,"_751":1802},"StackSpecContainerScaleThresholdCpu","Describes the CPU threshold at which scaling will occur.",[745,949],{"_745":1803,"_949":1805},{"_745":754,"_756":1804},[1771],{"_745":746,"_747":1806,"_751":1808},[1807],"utilization",{"_1807":1809},{"_745":915},{"_17":1811,"_745":746,"_19":1812,"_747":1813,"_751":1814},"StackSpecContainerScaleThresholdNetworkConnections","Describes the network connections threshold at which scaling will occur.",[745,949],{"_745":1815,"_949":1817},{"_745":754,"_756":1816},[1775],{"_745":746,"_747":1818,"_751":1820},[1819],"connections_total",{"_1819":1821},{"_745":915},{"_17":1823,"_745":746,"_19":1824,"_747":1825,"_751":1826},"StackSpecContainerScaleThresholdNetworkRequests","Describes the network requests threshold at which scaling will occur.",[745,949],{"_745":1827,"_949":1829},{"_745":754,"_756":1828},[1777],{"_745":746,"_747":1830,"_751":1832},[1831],"requests_total",{"_1831":1833},{"_745":915},{"_17":1835,"_745":746,"_19":1836,"_747":1837,"_751":1838},"StackSpecContainerScaleThresholdNetworkThroughput","Describes the network throughput threshold at which scaling will occur.",[745,949],{"_745":1839,"_949":1841},{"_745":754,"_756":1840},[1779],{"_745":746,"_747":1842,"_751":1845},[1843,1844],"private","bandwidth",{"_1843":1846,"_1844":1847},{"_745":819},{"_745":754,"_19":1848,"_777":1849},"The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event.",[1850,1851],"1gbps","50mbps",{"_801":802},{"_801":802},{"_745":765},"runtime",{"_869":1857},[1858,2111,2112],{"_17":1859,"_19":1860,"_745":746,"_751":1861},"StackSpecContainerConfigRuntime","Configuration options related to how the container behaves while it is running (environment variables, command overrides, kernel capabilities, etc. )",{"_1862":1863,"_1639":1868,"_1882":1883,"_1892":1893,"_1905":1906,"_1915":1916,"_1934":1935,"_2017":2018,"_2046":2047,"_1953":2052,"_2097":2098},"workdir",{"_19":1864,"_761":1865},"The working directory to execute the command in.",[1866,1867],{"_745":754},{"_801":802},{"_19":1869,"_761":1870},"The command to execute when this container starts. Will override the default specified in the container.",[1871,1881],{"_745":746,"_751":1872},{"_21":1873,"_1346":1877},{"_761":1874},[1875,1876],{"_745":754},{"_801":802},{"_761":1878},[1879,1880],{"_745":754},{"_801":802},{"_801":802},"environment_vars",{"_19":1884,"_761":1885},"A map of environment variables that will be injected into the container.",[1886,1891],{"_745":746,"_970":1887},{"_761":1888},[1889,1890],{"_745":754},{"_801":802},{"_801":802},"namespaces",{"_19":1894,"_761":1895},"Container namespaces to apply. By default, all are applied. Removing/changing this can have security implications.",[1896,1904],{"_745":786,"_787":1897},{"_745":754,"_756":1898},[1899,1900,1901,1388,1902,1261,1903],"ipc","pid","uts","mount","cgroup",{"_801":802},"sysctl",{"_19":1907,"_761":1908},"Sysctl options to apply.",[1909,1914],{"_745":746,"_970":1910},{"_761":1911},[1912,1913],{"_745":754},{"_801":802},{"_801":802},"rlimits",{"_19":1917,"_761":1918},"RLIMIT options to apply.",[1919,1933],{"_745":746,"_970":1920},{"_745":746,"_747":1921,"_751":1924},[1922,1923],"hard","soft",{"_1922":1925,"_1923":1929},{"_761":1926},[1927,1928],{"_745":915},{"_801":802},{"_761":1930},[1931,1932],{"_745":915},{"_801":802},{"_801":802},"seccomp",{"_19":1936,"_761":1937},"Configuration options for seccomp. Cycle enables seccomp by default.",[1938,2016],{"_745":746,"_747":1939,"_751":1941},[1406,1940],"rules",{"_1406":1942,"_1940":1946},{"_761":1943},[1944,1945],{"_745":819},{"_801":802},{"_761":1947},[1948,2015],{"_745":786,"_787":1949},{"_761":1950},[1951,2014],{"_745":746,"_747":1952,"_751":1955},[1953,1954],"capabilities","syscall",{"_1953":1956,"_1954":1972},{"_761":1957},[1958,1971],{"_745":746,"_747":1959,"_751":1962},[1960,1961],"includes","excludes",{"_1960":1963,"_1961":1967},{"_761":1964},[1965,1966],{"_745":754},{"_801":802},{"_761":1968},[1969,1970],{"_745":754},{"_801":802},{"_801":802},{"_761":1973},[1974,2013],{"_745":746,"_747":1975,"_751":1978},[1976,1977],"names","action",{"_1976":1979,"_1977":1981,"_1992":1993,"_1346":1994},{"_745":786,"_787":1980},{"_745":754},{"_745":754,"_756":1982},[1983,1984,1985,1986,1987,1988,1989,1990,1991],"SCMP_ACT_KILL","SCMP_ACT_KILL_PROCESS","SCMP_ACT_KILL_THREAD","SCMP_ACT_TRAP","SCMP_ACT_ERRNO","SCMP_ACT_TRACE","SCMP_ACT_ALLOW","SCMP_ACT_LOG","SCMP_ACT_NOTIFY","errnoRet",{"_745":915},{"_745":786,"_787":1995},{"_745":746,"_747":1996,"_751":1999},[1997,991,1998],"index","op",{"_1997":2000,"_991":2001,"_2002":2003,"_1998":2004},{"_745":915},{"_745":915},"valuetwo",{"_745":915},{"_745":754,"_756":2005},[2006,2007,2008,2009,2010,2011,2012],"SCMP_CMP_NE","SCMP_CMP_LT","SCMP_CMP_LE","SCMP_CMP_EQ","SCMP_CMP_GE","SCMP_CMP_GT","SCMP_CMP_MASKED_EQ",{"_801":802},{"_801":802},{"_801":802},{"_801":802},"host",{"_19":2019,"_761":2020},"Configuration options regarding the underlying host.",[2021,2045],{"_745":2022,"_751":2023},[746,765],{"_2024":2025,"_2031":2032,"_2038":2039},"expose_proc",{"_19":2026,"_761":2027},"If true, Cycle will mount the `/proc` directory into the container, giving it access to the host metrics. This is useful if you're running i.e. a monitoring agent.",[2028,2030],{"_745":2029},[819,765],{"_801":802},"expose_cgroups",{"_19":2033,"_761":2034},"If true, Cycle will mount the host's `/sys/fs/cgroups` directory into the container at `/var/run/cycle/host/cgroups`.",[2035,2037],{"_745":2036},[819,765],{"_801":802},"power_management",{"_19":2040,"_761":2041},"If true, Cycle will give the container instances access via internal api to power off or reboot the host server.",[2042,2044],{"_745":2043},[819,765],{"_801":802},{"_801":802},"privileged",{"_19":2048,"_761":2049},"If true, the container process will run in fully-privileged mode. **WARNING** This is considered insecure, and should only be done if you know what you're doing.",[2050,2051],{"_745":819},{"_801":802},{"_19":2053,"_761":2054},"Additional Linux kernel capabilities to apply to this container process.",[2055,2096],{"_745":786,"_787":2056},{"_745":754,"_756":2057},[2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2086,2087,2088,2089,2090,2091,2092,2093,2094,2095],"CAP_CHOWN","CAP_FSETID","CAP_DAC_OVERRIDE","CAP_FOWNER","CAP_SETFCAP","CAP_SETGID","CAP_SETUID","CAP_KILL","CAP_MKNOD","CAP_NET_BIND_SERVICE","CAP_NET_RAW","CAP_AUDIT_WRITE","CAP_SYS_CHROOT","CAP_SETPCAP","CAP_DAC_READ_SEARCH","CAP_NET_ADMIN","CAP_NET_BROADCAST","CAP_SYS_ADMIN","CAP_SYS_MODULE","CAP_SYS_NICE","CAP_SYS_PACCT","CAP_SYS_PTRACE","CAP_SYS_RAWIO","CAP_SYS_RESOURCE","CAP_SYS_BOOT","CAP_SYS_TIME","CAP_SYS_TTY_CONFIG","CAP_SYSLOG","CAP_AUDIT_CONTROL","CAP_AUDIT_READ","CAP_IPC_LOCK","CAP_IPC_OWNER","CAP_LINUX_IMMUTABLE","CAP_MAC_ADMIN","CAP_MAC_OVERRIDE","CAP_BLOCK_SUSPEND","CAP_LEASE","CAP_WAKE_ALARM",{"_801":802},"rootfs",{"_19":2099,"_761":2100},"Configuration options for the root filesystem.",[2101,2110],{"_745":746,"_747":2102,"_751":2104},[2103],"readonly",{"_2103":2105},{"_19":2106,"_761":2107},"If true, the container's filesystem will be read-only.",[2108,2109],{"_745":819},{"_801":802},{"_801":802},{"_801":802},{"_745":765},"resources",{"_869":2115},[2116,2164,2165],{"_17":2117,"_19":2118,"_745":746,"_747":2119,"_751":2120},"StackSpecContainerConfigResources","Configuration options for container resource limits and reserves.",[1771,1769],{"_1771":2121,"_1769":2145},{"_761":2122},[2123,2144],{"_745":746,"_751":2124},{"_2125":2126,"_2142":2143},"shares",{"_761":2127},[2128,2141],{"_745":746,"_747":2129,"_751":2132},[2130,2131],"limit","reserve",{"_2130":2133,"_2131":2137},{"_761":2134},[2135,2136],{"_745":915},{"_801":802},{"_761":2138},[2139,2140],{"_745":915},{"_801":802},{"_801":802},"cpus",{"_745":754},{"_801":802},{"_761":2146},[2147,2163],{"_745":746,"_751":2148},{"_2130":2149,"_2131":2153,"_2157":2158},{"_761":2150},[2151,2152],{"_745":754},{"_801":802},{"_761":2154},[2155,2156],{"_745":754},{"_801":802},"swappiness",{"_761":2159},[2160,2162],{"_745":2161},"number",{"_801":802},{"_801":802},{"_801":802},{"_745":765},"integrations",{"_869":2168},[2169,2365,2366],{"_17":2170,"_745":746,"_19":2171,"_751":2172},"StackSpecContainerConfigIntegrations","Configuration options for additional integrations/features that Cycle provides.",{"_2173":2174,"_2215":2216,"_2253":2254,"_2272":2273,"_2342":2343},"webhooks",{"_19":2175,"_761":2176},"Enable additional webhooks that Cycle will call out to during the course of a container's lifetime. All webhooks send a payload as an object containing the instance, container, server, and environment IDs.",[2177,2214],{"_745":2178,"_751":2179},[746,765],{"_2180":2181,"_1037":2208},"events",{"_19":2182,"_761":2183},"Webhooks that are triggered during a container event.",[2184,2207],{"_745":2185,"_751":2186},[746,765],{"_1389":2187,"_2193":2194,"_2200":2201},{"_19":2188,"_761":2189},"Cycle will call this endpoint when the container is deployed.",[2190,2192],{"_745":2191},[754,765],{"_801":802},"start",{"_19":2195,"_761":2196},"Cycle will call this endpoint when the container is started.",[2197,2199],{"_745":2198},[754,765],{"_801":802},"stop",{"_19":2202,"_761":2203},"Cycle will call this endpoint when the container is stopped.",[2204,2206],{"_745":2205},[754,765],{"_801":802},{"_801":802},{"_19":2209,"_761":2210},"The webhook to hit when the container's configuration is changed.",[2211,2213],{"_745":2212},[754,765],{"_801":802},{"_801":802},"lets_encrypt",{"_19":2217,"_761":2218},"When enabled, this integration will configure Let's Encrypt certificates that will be injected into the container at runtime. The certificates will be managed by the platform and renewed automatically.",[2219,2252],{"_745":2220,"_751":2221},[746,765],{"_2222":2223,"_2228":2229,"_2234":2235,"_2240":2241,"_2246":2247},"certificate_path",{"_761":2224},[2225,2227],{"_745":2226},[754,765],{"_801":802},"chain_path",{"_761":2230},[2231,2233],{"_745":2232},[754,765],{"_801":802},"key_path",{"_761":2236},[2237,2239],{"_745":2238},[754,765],{"_801":802},"bundle_path",{"_761":2242},[2243,2245],{"_745":2244},[754,765],{"_801":802},"additional_certs_path",{"_761":2248},[2249,2251],{"_745":2250},[754,765],{"_801":802},{"_801":802},"files",{"_19":2255,"_761":2256},"When enabled, Cycle will fetch and inject remote files into the container at the specified destination during runtime.",[2257,2271],{"_745":2258,"_787":2259},[786,765],{"_745":746,"_747":2260,"_751":2262},[930,2261],"destination",{"_930":2263,"_2261":2267},{"_761":2264},[2265,2266],{"_801":802},{"_745":754},{"_761":2268},[2269,2270],{"_745":754},{"_801":802},{"_801":802},"backups",{"_19":2274,"_761":2275},"When enabled, Cycle will automatically manage backups of this container. This is only available for stateful containers.",[2276,2341],{"_745":2277,"_747":2278,"_751":2281},[746,765],[2261,2279,2280,1686],"backup","restore",{"_1362":2282,"_2279":2291,"_2280":2316,"_1686":2334},{"_19":2283,"_761":2284},"An identifier of an integration that supports backups. All backups will be sent to this destination.",[2285,2290],{"_17":2286,"_745":754,"_19":2287,"_777":2288},"HybridIdentifier","Either a resource ID (objectid - i.e. 651586fca6078e98982dbd90) or a resource Identifier (human-readable)",[2289],"my-image-source",{"_801":802},{"_19":2292,"_761":2293},"Configuration options for how the container should be backed up.",[2294,2315],{"_745":746,"_747":2295,"_751":2297},[1639,1642,2296],"cron_string",{"_1639":2298,"_1642":2303,"_2296":2309},{"_19":2299,"_761":2300},"The command to run to capture a backup. The output sent to `STDOUT` will be captured and sent to the specified integration.",[2301,2302],{"_745":754},{"_801":802},{"_19":2304,"_869":2305},"How long the backup will attempt to run before timing out.",[2306,2307,2308],{"_801":1480},{"_801":802},{"_745":765},{"_19":2310,"_761":2311},"A cron string describing how often to run the backup command.",[2312,2314],{"_745":2313},[754,765],{"_801":802},{"_801":802},{"_19":2317,"_761":2318},"Configuration options for how the backup should be restored.",[2319,2333],{"_745":2320,"_747":2321,"_751":2322},[746,765],[1639,1642],{"_1639":2323,"_1642":2327},{"_761":2324},[2325,2326],{"_745":754},{"_801":802},{"_19":2328,"_869":2329},"The time in seconds for the restore to attempt to complete before timing out.",[2330,2331,2332],{"_801":1480},{"_801":802},{"_745":765},{"_801":802},{"_19":2335,"_869":2336,"_1453":2340},"How long the platform will keep backups. Default is 1 year.",[2337,2338,2339],{"_801":1480},{"_801":802},{"_745":765},"365d",{"_801":802},"shared_file_systems",{"_19":2344,"_761":2345},"When enabled, Cycle will mount a shared host directory into this container. The directory will be shared with all other containers that mount it.",[2346,2364],{"_745":2347,"_970":2348},[746,765],{"_761":2349},[2350,2363],{"_745":746,"_747":2351,"_751":2354},[2352,2353],"writable","mount_point",{"_2352":2355,"_2353":2359},{"_761":2356},[2357,2358],{"_745":819},{"_801":802},{"_761":2360},[2361,2362],{"_801":802},{"_745":754},{"_801":802},{"_801":802},{"_801":802},{"_745":765},{"_801":802},"role",{"_19":2370,"_745":2371,"_756":2372},"The role applied to this container. **Not yet implemented**",[754,765],[2373],"conductor","volumes",{"_19":2376,"_761":2377},"A list of configurations for volumes that will be attached to the container. Only applicable if the container is set to `stateful`.",[2378,2472],{"_745":2379,"_787":2380},[786,765],{"_17":2381,"_19":2382,"_745":746,"_747":2383,"_751":2384},"StackSpecContainerVolume","A container volume configuration.",[2261],{"_2385":2386,"_2261":2408,"_2413":2414,"_2419":2420,"_2425":2426},"local",{"_19":2387,"_761":2388},"Configuration options for local volumes.",[2389,2407],{"_745":746,"_747":2390,"_751":2392},[2391],"max_size",{"_2391":2393,"_2401":2402},{"_19":2394,"_761":2395},"The maximum size this volume can grow to. Container volumes on Cycle are thinly provisioned, meaning this isn't an allocation - the volume will only use the space it needs up to this size.",[2396,2400],{"_745":754,"_777":2397},[2398,2399],"5G","500M",{"_801":802},"storage_pool",{"_19":2403,"_761":2404},"A boolean where true signifies using the largest drive over 2TB for the target server.",[2405,2406],{"_745":819},{"_801":802},{"_801":802},{"_19":2409,"_761":2410},"The path this volume should be mounted at inside the container.",[2411,2412],{"_745":754},{"_801":802},"read_only",{"_19":2415,"_761":2416},"If true, the container will be unable to write data to the volume.",[2417,2418],{"_745":819},{"_801":802},"block_device",{"_761":2421,"_19":2424},[2422,2423],{"_745":819},{"_801":802},"Indicates that the volume will be used as unformatted block storage.\n","remote_access",{"_19":2427,"_761":2428},"Configuration options for setting up remote access to this volume via SFTP.",[2429,2471],{"_745":746,"_747":2430,"_751":2431},[1405,1151],{"_1405":2432,"_2437":2438,"_1265":2444,"_1151":2449},{"_19":2433,"_761":2434},"If true, this volume will be accessible over SFTP.",[2435,2436],{"_745":819},{"_801":802},"ips",{"_19":2439,"_761":2440},"A list of IPs that SFTP access will be limited to.",[2441,2443],{"_745":786,"_787":2442},{"_745":754},{"_801":802},{"_19":2445,"_761":2446},"If set, Cycle will call out to this URL for authentication. Anything other than a 200 response will be considered a validation failure.",[2447,2448],{"_745":754},{"_801":802},{"_19":2450,"_761":2451},"The password used for logging in to this volume via SFTP.",[2452,2470],{"_745":746,"_747":2453,"_751":2456},[2454,2455],"algorithm","data",{"_2454":2457,"_2455":2465},{"_19":2458,"_761":2459},"The algorithm the password is encoded with. `raw` means the password is plain-text.",[2460,2464],{"_745":754,"_756":2461},[942,2462,2463],"sha512","md5",{"_801":802},{"_19":2466,"_761":2467},"The password string.",[2468,2469],{"_745":754},{"_801":802},{"_801":802},{"_801":802},{"_801":802},"deprecate",{"_19":2475,"_761":2476},"If true, the container is marked as `deprecated`, and cannot be started anymore. Deprecated containers also don't count toward resource utilization.",[2477,2478],{"_745":819},{"_801":802},"lock",{"_19":2481,"_761":2482},"If true, the container is marked as `locked` and cannot be deleted in any way until the lock is lifted.",[2483,2484],{"_745":819},{"_801":802},{"_801":802},"monitoring",{"_19":2488,"_761":2489},"Monitoring options for containers within this stack.",[2490,2532],{"_17":2491,"_19":2492,"_745":746,"_751":2493},"StackSpecMonitoringConfig","Monitoring options for the stack build & containers within this stack.",{"_2494":2495},"logs",{"_761":2496},[2497,2530,2531],{"_17":2498,"_19":2499,"_745":746,"_751":2500},"StackSpecMonitoringLogs","Log configuration for containers in this stack.",{"_2494":2501},{"_761":2502},[2503,2528,2529],{"_745":746,"_751":2504},{"_2505":2506},"drain",{"_19":2507,"_761":2508},"When enabled, log drain allows logs to be exported to a third party service.",[2509,2526,2527],{"_745":746,"_747":2510,"_751":2511},[940],{"_940":2512,"_1334":2517},{"_19":2513,"_761":2514},"The URL to the third party logging service where logs will be sent.",[2515,2516],{"_745":754},{"_801":802},{"_19":2518,"_761":2519},"The format Cycle will use to send the logs.",[2520,2524,2525],{"_745":754,"_756":2521},[2522,2523],"ndjson-headers","ndjson-raw",{"_745":765},{"_801":802},{"_745":765},{"_801":802},{"_745":765},{"_801":802},{"_745":765},{"_801":802},{"_801":802},"services",{"_19":2535,"_761":2536},"Settings for any auxillary services deployed as part of the environment, such as load balancer and discovery services.",[2537,3645],{"_17":2538,"_745":2539,"_751":2540},"StackSpecServices",[746,765],{"_2541":2542,"_2608":2609,"_3528":3529,"_3583":3584},"discovery",{"_869":2543},[2544,2606,2607],{"_17":2545,"_19":2546,"_745":746,"_970":12,"_751":2547},"StackSpecDiscoveryService","Configuration options for the discovery service.",{"_2548":2549,"_1037":2555},"service",{"_869":2550},[2551,2553,2554],{"_801":2552},"#/properties/services/oneOf/0/properties/vpn/anyOf/0/properties/service/anyOf/0",{"_801":802},{"_745":765},{"_869":2556},[2557,2604,2605],{"_17":2558,"_745":746,"_751":2559},"StackSpecDiscoveryConfig",{"_2560":2561,"_2566":2567,"_2573":2574,"_2596":2597},"empty_set_delay",{"_869":2562},[2563,2564,2565],{"_801":1480},{"_801":802},{"_745":765},"dual_stack_legacy",{"_19":2568,"_869":2569},"When enabled, discovery will return both IPv6 and IPv4 when in legacy mode. Otherwise, only IPv4 will be returned.",[2570,2571,2572],{"_745":819},{"_801":802},{"_745":765},"hosts",{"_19":2575,"_761":2576},"A custom mapping of hosts - for forced resolution of specific IPs for a domain.",[2577,2595],{"_745":2578,"_970":2579},[746,765],{"_745":746,"_751":2580},{"_2581":2582,"_2588":2589},"ipv4",{"_761":2583},[2584,2587],{"_745":2585,"_787":2586},[786,765],{"_745":754},{"_801":802},"ipv6",{"_761":2590},[2591,2594],{"_745":2592,"_787":2593},[786,765],{"_745":754},{"_801":802},{"_801":802},"custom_resolvers",{"_19":2598,"_869":2599},"A list of custom DNS resolver strings. Can specifify domains or ips.",[2600,2602,2603],{"_745":786,"_787":2601},{"_745":754},{"_801":802},{"_745":765},{"_801":802},{"_745":765},{"_801":802},{"_745":765},"loadbalancer",{"_869":2610},[2611,3526,3527],{"_17":2612,"_19":2613,"_745":746,"_970":12,"_751":2614},"StackSpecLoadBalancerService","Configuration options for the load balancer service.",{"_2548":2615,"_1037":2620},{"_869":2616},[2617,2618,2619],{"_801":2552},{"_801":802},{"_745":765},{"_869":2621},[2622,3524,3525],{"_17":2623,"_745":746,"_19":2624,"_935":2625,"_761":2632},"StackSpecLoadBalancerConfig","The config object for the loadbalancer service.",{"_937":745,"_938":2626},{"_2627":2628,"_2629":2630,"_1453":2631},"haproxy","types/haproxy/StackSpecHaProxyLbType.yml","v1","types/v1/StackSpecV1LbType.yml","types/StackSpecDefaultLbType.yml",[2633,2798,3509],{"_17":2634,"_745":746,"_747":2635,"_751":2636},"StackSpecHaProxyLbType",[745,949,2581,2588],{"_2581":2637,"_2588":2642,"_745":2647,"_949":2649},{"_19":2638,"_761":2639},"Allow / disallow traffic to be routed via IPv4.",[2640,2641],{"_745":819},{"_801":802},{"_19":2643,"_761":2644},"Allow / disallow traffic to be routed via IPv6.",[2645,2646],{"_745":819},{"_801":802},{"_745":754,"_756":2648},[2627],{"_869":2650},[2651,2796,2797],{"_17":2652,"_745":746,"_19":2653,"_747":2654,"_751":2655},"StackSpecHaProxyConfig","Describes settings that are passed to HAProxy within the load balancer.",[1453,1414],{"_1453":2656,"_1414":2786},{"_19":2657,"_761":2658},"Settings that are applied to any port that is not overridden in the following ports section.",[2659,2785],{"_17":2660,"_745":746,"_747":2661,"_751":2664},"StackSpecHAProxyConfigSet",[2662,2663],"frontend","backend",{"_2662":2665,"_2663":2724},{"_761":2666},[2667,2723],{"_745":746,"_19":2668,"_747":2669,"_751":2673},"Settings that describe how incoming traffic to the load balancer is handled.",[2670,2671,2672],"mode","max_connections","timeouts",{"_2670":2674,"_2671":2681,"_2672":2687},{"_19":2675,"_761":2676},"The type of traffic expected by the load balancer for this port. Can be either: \n - tcp: Traffic is forwarded without any parsing or additional manipulation. \n - http: Traffic is treated as web traffic. If a LINKED record is configured for a container exposing this port, the domain will be parsed and it will be forwarded to the proper container. This allows multiple services to run on port 80 in the same environment.",[2677,2680],{"_745":754,"_756":2678},[2679,1136],"tcp",{"_801":802},{"_19":2682,"_761":2683},"The number of simultaneous connections that can be processed at a time.",[2684,2686],{"_745":2685},[915,765],{"_801":802},{"_19":2688,"_761":2689},"Various options for handling timeouts when communicating with the client.",[2690,2722],{"_745":2691,"_747":2692,"_751":2697},[746,765],[2693,2694,2695,2696],"client_secs","client_fin_ms","http_keep_alive_ms","http_request_ms",{"_2693":2698,"_2694":2704,"_2695":2710,"_2696":2716},{"_19":2699,"_761":2700},"The number of seconds the load balancer will wait for a response from a client before disconnecting.",[2701,2703],{"_745":2702},[915,765],{"_801":802},{"_19":2705,"_761":2706},"The number of milliseconds the load balancer will wait for a client to send it data when one direction is already closed. This is particularly useful to avoid keeping connections in a waiting state for too long when clients do not disconnect cleanly.",[2707,2709],{"_745":2708},[915,765],{"_801":802},{"_19":2711,"_761":2712},"The number of milliseconds the load balancer will wait for a new HTTP request to start coming after a response was set. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4.2-timeout%20http-request) for more information. (`http` mode only)",[2713,2715],{"_745":2714},[915,765],{"_801":802},{"_19":2717,"_761":2718},"The number of milliseconds the load balancer will wait for a complete HTTP request. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4.2-timeout%20http-request) for more information. (`http` mode only)",[2719,2721],{"_745":2720},[915,765],{"_801":802},{"_801":802},{"_801":802},{"_761":2725},[2726,2784],{"_745":746,"_19":2727,"_747":2728,"_751":2730},"Settings related to how the load balancer routes connections to container instances.",[2729,2672],"balance",{"_2729":2731,"_2672":2741},{"_19":2732,"_761":2733},"How connections are balanced across your container instances. Can be one of the following: \n - `roundrobin`: Each container instance is used in turns. \n - `static-rr`: Each container instance is used in turns, but is faster than Round Robin at the expense of being less dynamic. \n - `leastconn`: Routes traffic to the instance with the least number of active connections. \n - `first`: Routes traffic to the first available instance. \n - `source`: The same client IP always reaches the same container instance as long as no instance goes down or up.",[2734,2740],{"_745":754,"_756":2735},[2736,2737,2738,2739,930],"roundrobin","static-rr","leastconn","first",{"_801":802},{"_19":2742,"_761":2743},"Various options for handling timeouts when communicating with a container instance behind the load balancer.",[2744,2783],{"_745":2745,"_747":2746,"_751":2752},[746,765],[2747,2748,2749,2750,2751],"server_secs","server_fin_ms","connect_ms","queue_ms","tunnel_secs",{"_2747":2753,"_2748":2759,"_2749":2765,"_2750":2771,"_2751":2777},{"_19":2754,"_761":2755},"The number of seconds the load balancer will wait for a response from the container instance. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4.2-timeout%20server) for more information.",[2756,2758],{"_745":2757},[915,765],{"_801":802},{"_19":2760,"_761":2761},"The number of milliseconds the load balancer will wait for the server to send data when one direction is already closed. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4-timeout%20server-fin) for more information.",[2762,2764],{"_745":2763},[915,765],{"_801":802},{"_19":2766,"_761":2767},"The number of milliseconds the load balancer will wait for a successful connection to a container instance. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4-timeout%20connect) for more information.",[2768,2770],{"_745":2769},[915,765],{"_801":802},{"_19":2772,"_761":2773},"The number of milliseconds the load balancer will hold connections in a queue when the maximum number of connections has been reached. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4-timeout%20queue) for more information.",[2774,2776],{"_745":2775},[915,765],{"_801":802},{"_19":2778,"_761":2779},"The number of milliseconds the load balancer will allow for inactivity on a bidirectional tunnel. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4-timeout%20tunnel) for more information.",[2780,2782],{"_745":2781},[915,765],{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_19":2787,"_761":2788},"An object that defines how HAProxy will act on a specific port. The key is a custom port, and the value is the same settings object found under `default` above.",[2789,2795],{"_745":746,"_970":2790},{"_761":2791},[2792,2794],{"_801":2793},"#/properties/services/oneOf/0/properties/loadbalancer/anyOf/0/properties/config/anyOf/0/oneOf/0/properties/details/anyOf/0/properties/default/oneOf/0",{"_801":802},{"_801":802},{"_801":802},{"_745":765},{"_17":2799,"_745":746,"_747":2800,"_751":2801},"StackSpecV1LbType",[745,949,2581,2588],{"_2581":2802,"_2588":2806,"_745":2810,"_949":2812},{"_19":2638,"_761":2803},[2804,2805],{"_745":819},{"_801":802},{"_19":2643,"_761":2807},[2808,2809],{"_745":819},{"_801":802},{"_745":754,"_756":2811},[2629],{"_761":2813},[2814,3508],{"_17":2815,"_745":746,"_747":2816,"_751":2818},"StackSpecV1LbConfig",[2817],"controllers",{"_2817":2819,"_2826":2827,"_2844":3411},{"_19":2820,"_761":2821},"A configuration for a specific port.",[2822,2825],{"_745":786,"_787":2823},{"_801":2824},"#/properties/services/oneOf/0/properties/loadbalancer/anyOf/0/properties/config/anyOf/0/oneOf/1/properties/details/oneOf/0/properties/controller_template/anyOf/0",{"_801":802},"controller_template",{"_869":2828},[2829,3409,3410],{"_17":2830,"_745":746,"_747":2831,"_751":2833},"StackSpecV1LbController",[791,2832],"port",{"_791":2834,"_2832":2839,"_2844":2845,"_2851":2852},{"_19":2835,"_761":2836},"A human-readable identifier for this controller. It will default to the port, i.e. `port-443`, but can be renamed to anything, such as the service this controller represents.",[2837,2838],{"_745":754},{"_801":802},{"_19":2840,"_761":2841},"The port inbound trafic is accepted on.",[2842,2843],{"_745":915},{"_801":802},"waf",{"_869":2846},[2847,2849,2850],{"_801":2848},"#/properties/services/oneOf/0/properties/loadbalancer/anyOf/0/properties/config/anyOf/0/oneOf/1/properties/details/oneOf/0/properties/waf/anyOf/0",{"_801":802},{"_745":765},"transport",{"_17":2853,"_19":2854,"_761":2855},"V1LbControllerTransport","Defines how traffic comes in to the load balancer, and how the load balancer handles it.",[2856,3408],{"_745":2857,"_747":2858,"_751":2860},[746,765],[2670,1037,2859,1406],"routers",{"_1406":2861,"_2670":2866,"_1037":2873,"_2859":3040},{"_19":2862,"_761":2863},"When true, this controller is disabled and will not be used.",[2864,2865],{"_745":819},{"_801":802},{"_19":2867,"_761":2868},"The kind of traffic (http/tcp/udp) that will be sent to the load balancer.",[2869,2872],{"_745":754,"_756":2870},[2679,2871,1136],"udp",{"_801":802},{"_19":2874,"_761":2875},"Defines how the transport for this controller operates.",[2876,3039],{"_745":746,"_747":2877,"_751":2881},[2878,2879,2672,2880],"performance","ingress","verbosity",{"_2878":2882,"_2879":2887,"_2672":2906,"_2880":2919,"_2929":2930},{"_19":2883,"_761":2884},"Enable/disable performance mode. If enabled, some telemetry will be disabled to dedicate full processing to handling requests.\nYou will not see per-request breakdowns or URL logging if performance mode is enabled.\n",[2885,2886],{"_745":819},{"_801":802},{"_19":2888,"_761":2889},"Defines how traffic gets into the load balancer.",[2890,2905],{"_745":746,"_751":2891},{"_2892":2893},"tls",{"_761":2894},[2895,2904],{"_745":2896,"_747":2897,"_751":2898},[746,765],[1405],{"_1405":2899},{"_19":2900,"_761":2901},"Enables or disables TLS.",[2902,2903],{"_745":819},{"_801":802},{"_801":802},{"_801":802},{"_19":2907,"_761":2908},"Defines settings for various types of timeouts.",[2909,2918],{"_745":746,"_747":2910,"_751":2912},[2911],"idle",{"_2911":2913},{"_19":2914,"_761":2915},"The total amount of time a connection can be idle before being killed.",[2916,2917],{"_801":1480},{"_801":802},{"_801":802},{"_19":2920,"_761":2921},"Verbosity describes the level of logging detail for the controller",[2922,2928],{"_745":754,"_756":2923},[2924,2925,2926,2927],"low","normal","high","debug",{"_801":802},"extension",{"_19":2931,"_761":2932},"Extended configurations for the specified transport mode (http/tcp)",[2933,3038],{"_745":746,"_935":2934,"_761":2939},{"_937":745,"_938":2935},{"_2679":2936,"_1136":2937,"_2871":2938},"transports/StackSpecTcpTransportConfig.yml","transports/StackSpecHttpTransportConfig.yml","transports/StackSpecUdpTransportConfig.yml",[2940,2965,3020],{"_17":2941,"_19":2942,"_745":746,"_747":2943,"_751":2944},"StackSpecTcpTransportConfig","Additional configuration options for the TCP transport mode.",[745,949],{"_745":2945,"_949":2947},{"_745":754,"_756":2946},[2679],{"_761":2948},[2949,2964],{"_745":746,"_747":2950,"_751":2952},[2951,1678],"connections",{"_2951":2953,"_1678":2958},{"_761":2954},[2955,2957],{"_745":746,"_970":2956},{},{"_801":802},{"_19":2959,"_761":2960},"Configuration options for how telemetry is handled on the load balancer.",[2961,2963],{"_745":746,"_970":2962},{},{"_801":802},{"_801":802},{"_17":2966,"_19":2967,"_745":746,"_747":2968,"_751":2969},"StackSpecHttpTransportConfig","Additional configuration options for the HTTP transport mode.",[745,949],{"_745":2970,"_949":2972},{"_745":754,"_756":2971},[1136],{"_761":2973},[2974,3019],{"_745":746,"_747":2975,"_751":2976},[2951,1678],{"_2951":2977,"_1678":2991},{"_761":2978},[2979,2990],{"_745":746,"_747":2980,"_19":2982,"_751":2983},[2981],"max_idle_conns_per_connection","Defines extra configuration options connections to the load balancer",{"_2981":2984},{"_761":2985},[2986,2989],{"_745":2987,"_19":2988},[915,765],"Maximum number of simultaneous connections (via http/2) per connection.",{"_801":802},{"_801":802},{"_761":2992},[2993,3018],{"_745":746,"_19":2994,"_751":2995},"Configuration options for how telemetry is handled.",{"_2996":2997,"_3003":3004,"_3010":3011},"max_trackable_urls",{"_19":2998,"_761":2999},"Determines how many URLs the load balancer will track at one time. Defaults to 150.",[3000,3002],{"_745":3001},[915,765],{"_801":802},"track_invalid_requests",{"_19":3005,"_761":3006},"Whether or not to track invalid requests. An invalid request is a request that came in that no router existed for. Usually this means bot requests. Defaults to false.",[3007,3009],{"_745":3008},[819,765],{"_801":802},"ignore_paths",{"_19":3012,"_761":3013},"An array of paths to exclude from tracking.",[3014,3017],{"_745":3015,"_787":3016},[786,765],{"_745":754},{"_801":802},{"_801":802},{"_801":802},{"_17":3021,"_19":3022,"_745":746,"_747":3023,"_751":3024},"StackSpecUdpTransportConfig","Additional configuration options for the UDP transport mode.",[745,949],{"_745":3025,"_949":3027},{"_745":754,"_756":3026},[2871],{"_761":3028},[3029,3037],{"_745":746,"_747":3030,"_751":3031},[1678],{"_1678":3032},{"_19":2959,"_761":3033},[3034,3036],{"_745":746,"_970":3035},{},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_19":3041,"_761":3042},"Defines where traffic is sent. Many can be defined per controller.",[3043,3407],{"_745":786,"_787":3044},{"_761":3045},[3046,3406],{"_17":3047,"_19":3048,"_745":746,"_747":3049,"_751":3051},"StackSpecV1LbRouterConfig","A specific router configuration that describes how traffic matching the rule is handled.",[3050,2670,1037],"match",{"_3050":3052,"_2670":3103,"_1037":3112},{"_761":3053},[3054,3102],{"_745":746,"_19":3055,"_747":3056,"_751":3059},"The ruleset for this router to be selected. If both `domains`` and `internal_port` are null, then this match acts as a wildcard and will match all.",[3057,3058],"domains","internal_ports",{"_3057":3060,"_3058":3067,"_21":3074,"_750":3079},{"_19":3061,"_761":3062},"The specific domains to match against.",[3063,3066],{"_745":3064,"_787":3065},[786,765],{"_745":754},{"_801":802},{"_19":3068,"_761":3069},"The specific ports to match against.",[3070,3073],{"_745":3071,"_787":3072},[786,765],{"_745":915},{"_801":802},{"_761":3075},[3076,3078],{"_745":3077},[754,765],{"_801":802},{"_19":3080,"_761":3081},"Match traffic destined (or not destined) for a particular container.",[3082,3101],{"_745":3083,"_751":3084},[746,765],{"_3085":3086,"_3093":3094},"include",{"_19":3087,"_761":3088},"Match any traffic that would be routed to one of these containers.",[3089,3092],{"_745":3090,"_787":3091},[786,765],{"_801":1366},{"_801":802},"exclude",{"_19":3095,"_761":3096},"Match any traffic that would NOT be routed to one of these containers.",[3097,3100],{"_745":3098,"_787":3099},[786,765],{"_801":1366},{"_801":802},{"_801":802},{"_801":802},{"_19":3104,"_761":3105},"How to route the traffic to the destination.\n`random`: Pick a valid destination at random.\n`round-robin`: Send each request to the 'next' destination on the list, restarting from the beginning when the last destination is used.\n`source-ip`: Utilizes a hash function to ensure traffic from an IP will always hit the same destination instance.\n",[3106,3111],{"_745":754,"_756":3107},[3108,3109,3110],"random","round-robin","source-ip",{"_801":802},{"_761":3113},[3114,3405],{"_745":746,"_747":3115,"_751":3118},[3116,3117,2672],"sticky_sessions","destination_retries",{"_3116":3119,"_3117":3124,"_3129":3130,"_2892":3139,"_2672":3179,"_2929":3192},{"_19":3120,"_761":3121},"If a request comes in from the same origin, ensure it hits the same destination.",[3122,3123],{"_745":819},{"_801":802},{"_19":3125,"_761":3126},"If a destination is unavailable, retry up to [x] times, instead of immediately failing with a 503/504 error.",[3127,3128],{"_745":915},{"_801":802},"destination_prioritization",{"_761":3131},[3132,3137,3138],{"_745":754,"_19":3133,"_756":3134},"Hints to the load balancer how to prioritize traffic to instances.\n**random**: Chooses a random instance. **latency**: Prioritizes lower latency instances. **fixed**: The order of the destinations will be the same regardless of instance or load balancer location. Used primarily with source IP routing.\n",[3135,3108,3136],"latency","fixed",{"_801":802},{"_745":765},{"_19":3140,"_761":3141},"TLS termination configuration. If null, the platform will use the default configuration. Port 443 by default has TLS termination enabled.",[3142,3178],{"_745":3143,"_751":3144},[746,765],{"_3145":3146,"_3152":3153,"_3159":3160,"_3166":3167},"server_name",{"_19":3147,"_761":3148},"[Advanced] Change the domain the controller listens on.\n",[3149,3151],{"_745":3150},[754,765],{"_801":802},"allow_insecure",{"_19":3154,"_761":3155},"If enabled, accept TLS traffic with an invalid certificate. This is usually done for development/testing, and is not recommended for production use.",[3156,3158],{"_745":3157},[819,765],{"_801":802},"client_cert_auth",{"_19":3161,"_761":3162},"A PEM encoded string of certificates.",[3163,3165],{"_745":3164},[754,765],{"_801":802},"client_auth",{"_19":3168,"_761":3169},"Defines how to validate the connecting TLS certificate.\n`none`: Do not require a TLS certificate to be sent\n`request`: Asks the client to send a TLS certificate, but does not require nor validate it.\n`require`: Requires a certificate be sent for the request to be valid, but does not validate the certificate.\n`require-verify`: Requires both that the client send a certificate, and that the certificate is valid. This is required when using https.\n",[3170,3176,3177],{"_745":754,"_756":3171},[3172,3173,3174,3175],"none","request","require","require-verify",{"_801":802},{"_745":765},{"_801":802},{"_19":3180,"_761":3181},"Defines how the length of various sorts of timeouts when communicating with the destination.",[3182,3191],{"_745":746,"_747":3183,"_751":3185},[3184],"destination_connection",{"_3184":3186},{"_19":3187,"_761":3188},"The duration the load balancer will wait before timing out while attempting to connect to the destination.",[3189,3190],{"_801":1480},{"_801":802},{"_801":802},{"_869":3193},[3194,3195],{"_745":765},{"_745":746,"_19":3196,"_935":3197,"_761":3202},"Additional configuration options specific to the selected mode (tcp/http).",{"_937":745,"_938":3198},{"_2679":3199,"_2871":3200,"_1136":3201},"routers/StackSpecTcpRouterConfig.yml","routers/StackSpecUdpRouterConfig.yml","routers/StackSpecHttpRouterConfig.yml",[3203,3215,3393],{"_17":3204,"_19":3205,"_745":746,"_747":3206,"_751":3207},"StackSpecTcpRouterConfig","Additional configuration options for TCP mode routers",[745,949],{"_745":3208,"_949":3210},{"_745":754,"_756":3209},[2679],{"_761":3211},[3212,3214],{"_745":746,"_970":3213},{},{"_801":802},{"_17":3216,"_19":3217,"_745":746,"_747":3218,"_751":3219},"StackSpecHttpRouterConfig","Additional configuration options for HTTP mode routers.",[745,949],{"_745":3220,"_949":3222},{"_745":754,"_756":3221},[1136],{"_761":3223},[3224,3392],{"_745":746,"_751":3225},{"_3226":3227,"_3266":3267,"_3316":3317,"_3361":3362},"redirect",{"_19":3228,"_761":3229},"Defines a built-in redirect for HTTP mode routers",[3230,3265],{"_745":3231,"_747":3232,"_751":3235},[746,765],[3233,3234],"auto_https_redirect","remove_www",{"_3233":3236,"_3234":3241,"_2832":3246,"_3252":3253,"_940":3259},{"_19":3237,"_761":3238},"If enabled and a sibling controller exists for port 443, requests will be auto redirected to it. Essentially sets up automatic TLS redirection for this router.",[3239,3240],{"_745":819},{"_801":802},{"_19":3242,"_761":3243},"If true, any request comes in with \"www\" prefix will be permanently redirected to the same path without www.",[3244,3245],{"_745":819},{"_801":802},{"_19":3247,"_761":3248},"The port to redirect traffic to.",[3249,3251],{"_745":3250},[915,765],{"_801":802},"scheme",{"_19":3254,"_761":3255},"The scheme to redirect to. (i.e. `https`)",[3256,3258],{"_745":3257},[754,765],{"_801":802},{"_19":3260,"_761":3261},"A specific URL to redirect to.",[3262,3264],{"_745":3263},[754,765],{"_801":802},{"_801":802},"forward",{"_761":3268},[3269,3315],{"_745":3270,"_751":3271},[746,765],{"_3252":3272,"_3277":3278,"_940":3308},{"_761":3273},[3274,3276],{"_745":3275},[754,765],{"_801":802},"content_mod",{"_19":3279,"_761":3280},"Allows the load balancer to modify content before it reaches the user.",[3281,3307],{"_745":3282,"_751":3283},[746,765],{"_3284":3285},"replace",{"_19":3286,"_761":3287},"An array that describes a list of replacement match/value pairs.",[3288,3306],{"_745":3289,"_787":3290},[786,765],{"_761":3291},[3292,3305],{"_745":746,"_747":3293,"_751":3294},[3050,991],{"_3050":3295,"_991":3300},{"_19":3296,"_761":3297},"String that will be replaced.",[3298,3299],{"_745":754},{"_801":802},{"_19":3301,"_761":3302},"Replacement value.",[3303,3304],{"_745":754},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_19":3309,"_777":3310,"_761":3312},"The URL to forward the request to.\n\nGiven a path match of `^/example/(.*)$`, a route such as `/example/wow.jpg` would be forwarded as /wow.jpg.\n",[3311],"/$$1",[3313,3314],{"_745":754},{"_801":802},{"_801":802},"proxy",{"_761":3318},[3319,3360],{"_745":3320,"_751":3321},[746,765],{"_3322":3323,"_940":3329,"_3277":3335},"domain",{"_19":3324,"_761":3325},"The domain that this router will proxy.",[3326,3328],{"_745":3327},[754,765],{"_801":802},{"_19":3330,"_761":3331},"The full URL that this router will proxy.",[3332,3333,3334],{"_745":754},{"_801":802},{"_745":765},{"_19":3279,"_761":3336},[3337,3359],{"_745":3338,"_751":3339},[746,765],{"_3284":3340},{"_19":3286,"_761":3341},[3342,3358],{"_745":3343,"_787":3344},[786,765],{"_761":3345},[3346,3357],{"_745":746,"_747":3347,"_751":3348},[3050,991],{"_3050":3349,"_991":3353},{"_19":3296,"_761":3350},[3351,3352],{"_745":754},{"_801":802},{"_19":3301,"_761":3354},[3355,3356],{"_745":754},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_801":802},"caching",{"_761":3363},[3364,3391],{"_745":3365,"_751":3366},[746,765],{"_2253":3367},{"_761":3368},[3369,3390],{"_745":3370,"_787":3371},[786,765],{"_761":3372},[3373,3389],{"_745":746,"_747":3374,"_751":3376},[3050,3375],"ttl",{"_3050":3377,"_3375":3384},{"_19":3378,"_777":3379,"_761":3381},"Regex string that describes the files to cache.",[3380],"(.*)\\.(js|jpg|css|png|svg)$",[3382,3383],{"_745":754},{"_801":802},{"_19":3385,"_761":3386},"Time string that describes the time to live.",[3387,3388],{"_801":1480},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_17":3394,"_19":3395,"_745":746,"_747":3396,"_751":3397},"StackSpecUdpRouterConfig","Additional configuration options for UDP mode routers",[745,949],{"_745":3398,"_949":3400},{"_745":754,"_756":3399},[2871],{"_761":3401},[3402,3404],{"_745":746,"_970":3403},{},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_745":765},{"_869":3412},[3413,3506,3507],{"_17":3414,"_745":746,"_19":3415,"_747":3416,"_751":3417},"StackSpecWafConfig","Additional configuration options for the web application firewall.",[1940],{"_1940":3418},{"_761":3419},[3420,3505],{"_745":786,"_787":3421},{"_761":3422},[3423,3504],{"_745":746,"_747":3424,"_751":3427},[19,3425,745,3426],"skip","conditions",{"_19":3428,"_3425":3433,"_745":3438,"_3446":3447,"_3050":3456,"_3426":3462},{"_19":3429,"_761":3430},"Some information about the rule.",[3431,3432],{"_745":754},{"_801":802},{"_19":3434,"_761":3435},"A boolean that indicates if the rule should be active or skipped.",[3436,3437],{"_745":819},{"_801":802},{"_19":3439,"_761":3440},"A string that describes if the role should allow or deny traffic based on the conditions.",[3441,3445],{"_745":754,"_756":3442},[3443,3444],"allow","deny",{"_801":802},"expires",{"_19":3448,"_761":3449},"The expiration date of the WAF config, if present.",[3450,3454,3455],{"_745":754,"_1334":3451,"_777":3452},"date-time",[3453],"2021-01-30T08:30:00Z",{"_801":802},{"_745":765},{"_19":3457,"_761":3458},"A string that describes if both attributes need to be true (match all) or if only one of the conditions needs to be true (match any).",[3459,3461],{"_745":754,"_756":3460},[1525,1532],{"_801":802},{"_19":3463,"_761":3464},"An array of the specific conditions for the rule.",[3465,3503],{"_745":786,"_787":3466},{"_761":3467},[3468,3502],{"_745":746,"_747":3469,"_751":3471},[745,3470,991],"operator",{"_745":3472,"_3470":3483,"_991":3495},{"_19":3473,"_761":3474},"A string that describes the match type for the condition.",[3475,3482],{"_745":754,"_756":3476},[3477,3478,3479,3480,3481],"ip-match","geo-match","url-match","method-match","header-match",{"_801":802},{"_19":3484,"_761":3485},"A string that indicates the range of values relative to the value property.",[3486,3494],{"_745":754,"_756":3487},[3488,3489,3490,3491,3492,3493],"==","!=",">","<",">=","<=",{"_801":802},{"_19":3496,"_777":3497,"_761":3499},"The value corresponding to the condition type.",[3498],"0.0.0.0/0",[3500,3501],{"_745":754},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_801":802},{"_745":765},{"_801":802},{"_17":3510,"_745":746,"_747":3511,"_751":3512},"StackSpecDefaultLbType",[745,949,2581,2588],{"_2581":3513,"_2588":3514,"_745":3515,"_949":3517},{"_745":819,"_19":2638},{"_745":819,"_19":2643},{"_745":754,"_756":3516},[1453],{"_761":3518},[3519,3521,3523],{"_801":3520},"#/properties/services/oneOf/0/properties/loadbalancer/anyOf/0/properties/config/anyOf/0/oneOf/0/properties/details/anyOf/0",{"_801":3522},"#/properties/services/oneOf/0/properties/loadbalancer/anyOf/0/properties/config/anyOf/0/oneOf/1/properties/details/oneOf/0",{"_745":765},{"_801":802},{"_745":765},{"_801":802},{"_745":765},"scheduler",{"_869":3530},[3531,3581,3582],{"_17":3532,"_19":3533,"_745":746,"_970":12,"_751":3534},"StackSpecSchedulerService","Configuration options for the scheduler service.",{"_2548":3535,"_1037":3540},{"_869":3536},[3537,3538,3539],{"_801":2552},{"_801":802},{"_745":765},{"_869":3541},[3542,3579,3580],{"_17":3543,"_19":3544,"_745":3545,"_747":3546,"_751":3547},"StackSpecSchedulerConfig","Scheduler specific configuration options.",[746,765],[1397],{"_1397":3548,"_3553":3554},{"_19":3549,"_761":3550},"If true, this scheduler will be accessible over the public internet. It will enable a LINKED record to be pointed to the scheduler container, and inbound requests to trigger function containers.",[3551,3552],{"_745":819},{"_801":802},"access_keys",{"_761":3555},[3556,3578],{"_745":786,"_787":3557},{"_17":3558,"_19":3559,"_745":746,"_747":3560,"_751":3561},"StackSpecSchedulerAccessKey","Custom authorization keys for the scheduler service.",[1035,1004],{"_1035":3562,"_1004":3567,"_2437":3572},{"_19":3563,"_761":3564},"The name given to this access key.",[3565,3566],{"_745":754},{"_801":802},{"_19":3568,"_761":3569},"The access key secret. This should be submitted with requests to a publicly accessible scheduler service.",[3570,3571],{"_745":754},{"_801":802},{"_19":3573,"_761":3574},"Whitelisted IPs that are allowed to make requests to the scheduler service.",[3575,3577],{"_745":786,"_787":3576},{"_745":754},{"_801":802},{"_801":802},{"_801":802},{"_745":765},{"_801":802},{"_745":765},"vpn",{"_869":3585},[3586,3643,3644],{"_17":3587,"_19":3588,"_745":746,"_970":12,"_751":3589},"StackSpecVpnService","Configuration options for the VPN service.",{"_2548":3590,"_1037":3606},{"_869":3591},[3592,3604,3605],{"_17":3593,"_19":3594,"_745":746,"_751":3595},"StackService","Stack spec configuration options common to all environment services. If one of these properties is defined, all must be.",{"_1405":3596,"_3598":3599,"_3601":3602},{"_19":3597,"_745":819},"Whether or not this service should be enabled.","high_availability",{"_19":3600,"_745":819},"Whether or not Cycle should run multiple instances of this service for high availability.","auto_update",{"_19":3603,"_745":819},"Whether or not Cycle should automatically update this service when a new version is released.",{"_801":802},{"_745":765},{"_869":3607},[3608,3641,3642],{"_17":3609,"_19":3610,"_745":746,"_747":3611,"_751":3613},"StackSpecVpnConfig","VPN specific configuraiton options.",[1128,3612],"allow_internet",{"_1128":3614,"_3612":3637},{"_761":3615},[3616,3636],{"_745":746,"_747":3617,"_751":3620},[3618,3619],"cycle_accounts","vpn_accounts",{"_1265":3621,"_3618":3626,"_3619":3631},{"_19":3622,"_761":3623},"The endpoint to hit when attempting to authorize a VPN account. If the endpoint returns a 200 response, access is granted. Otherwise it is denied.",[3624,3625],{"_745":754},{"_801":802},{"_19":3627,"_761":3628},"If true, any account with access to this environment on Cycle can use their Cycle credentials to log in to this VPN.",[3629,3630],{"_745":819},{"_801":802},{"_19":3632,"_761":3633},"If true, Cycle will allow custom accounts to be created for logging into this VPN.",[3634,3635],{"_745":819},{"_801":802},{"_801":802},{"_761":3638},[3639,3640],{"_745":819},{"_801":802},{"_801":802},{"_745":765},{"_801":802},{"_745":765},{"_801":802},{"_19":3647,"_761":3648},"Additional meta info about the stack.",[3649,3651],{"_745":746,"_970":3650},{},{"_801":802},"actionData","errors"]