diff --git a/apps/docs/content/references/import.mdx b/apps/docs/content/references/import.mdx index 7ffad003..0bcefed5 100644 --- a/apps/docs/content/references/import.mdx +++ b/apps/docs/content/references/import.mdx @@ -29,6 +29,8 @@ project: name: project0 # Project description description: "This project is an example only" + # Project core package - LIGHT/SERIOUS + corePackage: SERIOUS # List of project tags for filtering tags: - test @@ -121,8 +123,8 @@ services: -:::warning -This is a general guideline; not all keys are valid for every service type. For technology-specific details, refer to the **Create service** page in the **How To** section of the Zerops documentation. +:::note +The example above is a general guideline; not all keys are valid for every service type. For technology-specific details, refer to the **Create service** page in the **How To** section of the Zerops documentation. ::: --- @@ -137,9 +139,6 @@ The project configuration is used to define the project you want to import. #### Usage - - - @@ -150,38 +149,38 @@ The project configuration is used to define the project you want to import. - + - + - + - + - - - + + + + + + + + - + - +
projectproject object - _REQUIRED, if a whole project is imported_ - Only one project can be defined. - _REQUIRED, if a whole project is imported_
Only one project can be defined.
namename string, REQUIRED - The name of the new project. Duplicates are allowed. - The name of the new project. Duplicates are allowed.
descriptionstring - Description of the new project. - descriptionstringDescription of the new project.
corePackagestringCore package of the new project.
Values: LIGHT/SERIOUS (default LIGHT)
tagstags list of strings - One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. - One or more string tags.
Tags do not have a functional meaning, they only provide better orientation in projects.
- - + +:::warning +The `corePackage` value can't be changed later. Make sure to choose a suitable core package for your project. +::: + +This example will create a project named `project0` with [serious core](/features/infrastructure#serious-core) package and the description `This project is an example only`. The project will have two tags: `test` and `dev`: ```yml # ==== Define a project to import ==== @@ -190,16 +189,14 @@ project: name: project0 # Project description description: "This project is an example only" + # Project core package + corePackage: SERIOUS # List of project tags for filtering tags: - test - dev ``` -This will create a project with the name `project0` and the description `This project is an example only`. The project will have two tags: `test` and `dev`. - -The `project` object requires only the `name` parameter - both `description` and `tags` are optional. - ### Service Configuration The service configuration is used to define the services, environment variables, and other settings you want to import into the project(You require at least one service and you need to have a project to import into or define the project in the yaml). @@ -207,7 +204,7 @@ The service configuration is used to define the services, environment variables, #### Usage - + @@ -219,14 +216,12 @@ The service configuration is used to define the services, environment variables, - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
servicesservices list of objects, REQUIRED - At least one service is required. - At least one service is required.
hostnamehostname string, REQUIRED The unique service identifier. @@ -236,36 +231,27 @@ The service configuration is used to define the services, environment variables,
typetype enum, REQUIRED - Specifies the service type and version. See [supported types](/references/importyml/type-list). - Specifies the service type and version. See [supported types](/references/importyml/type-list).
modemode enum - Values: **HA / NON_HA** (default NON_HA) - Defines the operation mode of the service. - Values: HA / NON_HA (default NON_HA)
Defines the operation mode of the service.
envSecretsenvSecrets map[string]string - Environment variables that are blurred by default in Zerops GUI. Can be edited or deleted in Zerops GUI. - Environment variables that are blurred by default in Zerops GUI. Can be edited or deleted in Zerops GUI.
objectStorageSizeobjectStorageSize integer - Object storage size in GB. - Object storage size in GB.
objectStoragePolicyobjectStoragePolicy enum Values: **private / public-read / public-objects-read / public-write / public-read-write / custom** @@ -273,7 +259,7 @@ The service configuration is used to define the services, environment variables,
objectStorageRawPolicyobjectStorageRawPolicy json Define your own AWS S3 bucket access policy. See [AWS docs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html) for details. @@ -281,14 +267,14 @@ The service configuration is used to define the services, environment variables,
buildFromGitbuildFromGit string (URL) A URL of a Github or Gitlab repository used for a one-time build of your service.
enableSubdomainAccessenableSubdomainAccess boolean Default: false @@ -296,7 +282,7 @@ The service configuration is used to define the services, environment variables,
prioritypriority integer Services are sorted before creation by priority in descending order, i.e. the higher the priority the sooner the service is created. @@ -355,7 +341,7 @@ The vertical autoscaling configuration is used to define the vertical autoscalin #### Usage - + @@ -367,78 +353,78 @@ The vertical autoscaling configuration is used to define the vertical autoscalin - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -558,7 +544,7 @@ services: - teststorage1 ``` -The `mount: |-` parameter allows you to mount a shared storage(should be created inside the project) to the service. +The `mount: |-` parameter allows you to mount a shared storage (should be created inside the project) to the service. ### Using Nginx Configuration @@ -577,7 +563,7 @@ The nginx configuration is used to define the nginx settings for the service. - + @@ -628,7 +614,7 @@ This shows you how you can use the `zeropsSetup` parameter as a way to insert a - +
minCpuminCpu integer Minimum number of virtual CPUs
maxCpumaxCpu integer Maximum number of virtual CPUs
cpuModecpuMode enum Values: **SHARED / DEDICATED**
minRamminRam float Minimum RAM in GB that each container of the service can scale down to.
maxRammaxRam float Maximum RAM in GB that each container of the service can scale up to.
minDiskminDisk float Minimum disk space in GB that each container of the service can scale down to.
maxDiskmaxDisk float Maximum disk space in GB that each container of the service can scale up to.
startCpuCoreCountstartCpuCoreCount integer Number of CPU cores with which each container starts.
minFreeCpuCoresminFreeCpuCores float Minimum number of unused CPU cores before a container starts scaling.
minFreeCpuPercentminFreeCpuPercent float Minimum percentage of unused CPU cores before a container starts scaling.
minFreeRamGBminFreeRamGB float Minimum unused memory in GB before a container starts scaling.
minFreeRamPercentminFreeRamPercent float Minimum percentage of unused memory before a container starts scaling. @@ -486,7 +472,7 @@ The horizontal autoscaling configuration is used to define the horizontal autosc #### Usage - + @@ -497,14 +483,14 @@ The horizontal autoscaling configuration is used to define the horizontal autosc - + - + - + - +
minContainersminContainers integerDefault: 1, maximum value: 6 - Minimum number of containers of the service.Minimum number of containers of the service.
Default: 1, maximum value: 6
maxContainersmaxContainers integerMaximum value: 6 - Maximum number of containers of the service.Maximum number of containers of the service.
Maximum value: 6
@@ -541,7 +527,7 @@ The mount shared storage configuration is used to define the shared storage to m
mountmount list of strings Mount shared storage to the service. `buildFromGit` must be filled.
nginxConfignginxConfig string (multiline) Insert full nginx config.
zeropsSetupzeropsSetup string or object Provide the name of the service from your zerops.yml (find it under `-setup: {name}`) or insert full [zerops.yml configuration file](/zerops-yml/specification).