diff --git a/index.html b/index.html index ecbecc97..f97e53af 100644 --- a/index.html +++ b/index.html @@ -2689,7 +2689,7 @@

Response samples

Content type
application/json
{
  • "aws.cloudwatch.eks_logs_retention_days": 90,
  • "aws.vpc.enable_s3_flow_logs": false,
  • "aws.vpc.flow_logs_retention_days": 365,
  • "loki.log_retention_in_week": 12,
  • "registry.image_retention_time": 31536000,
  • "cloud_provider.container_registry.tags": {
    },
  • "load_balancer.size": "lb-s",
  • "database.postgresql.deny_public_access": false,
  • "database.postgresql.allowed_cidrs": [
    ],
  • "database.mysql.deny_public_access": false,
  • "database.mysql.allowed_cidrs": [
    ],
  • "database.mongodb.deny_public_access": false,
  • "database.mongodb.allowed_cidrs": [
    ],
  • "database.redis.deny_public_access": false,
  • "database.redis.allowed_cidrs": [
    ],
  • "aws.iam.admin_group": "Admins",
  • "aws.eks.ec2.metadata_imds": "optional",
  • "pleco.resources_ttl": -1,
  • "registry.mirroring_mode": "CLUSTER"
}

Edit advanced settings

Edit advanced settings by returning table of advanced settings.

+

Response samples

Content type
application/json
{
  • "aws.cloudwatch.eks_logs_retention_days": 90,
  • "aws.vpc.enable_s3_flow_logs": false,
  • "aws.vpc.flow_logs_retention_days": 365,
  • "loki.log_retention_in_week": 12,
  • "registry.image_retention_time": 31536000,
  • "cloud_provider.container_registry.tags": {
    },
  • "load_balancer.size": "lb-s",
  • "database.postgresql.deny_public_access": false,
  • "database.postgresql.allowed_cidrs": [
    ],
  • "database.mysql.deny_public_access": false,
  • "database.mysql.allowed_cidrs": [
    ],
  • "database.mongodb.deny_public_access": false,
  • "database.mongodb.allowed_cidrs": [
    ],
  • "database.redis.deny_public_access": false,
  • "database.redis.allowed_cidrs": [
    ],
  • "aws.iam.admin_group": "Admins",
  • "aws.eks.ec2.metadata_imds": "optional",
  • "pleco.resources_ttl": -1,
  • "registry.mirroring_mode": "CLUSTER",
  • "nginx.vcpu.request_in_milli": 100,
  • "nginx.vcpu.limit_in_milli": 500,
  • "nginx.memory.request_in_mib": 768,
  • "nginx.memory.limit_in_mib": 768,
  • "nginx.hpa.cpu_utilization_percentage_threshold": 50,
  • "nginx.hpa.memory_utilization_percentage_threshold": 50,
  • "nginx.hpa.min_number_instances": 2,
  • "nginx.hpa.max_number_instances": 25
}

Edit advanced settings

Edit advanced settings by returning table of advanced settings.

Authorizations:
bearerAuthApiKeyAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Request Body schema: application/json
aws.cloudwatch.eks_logs_retention_days
integer
Default: 90

Set the number of retention days for EKS Cloudwatch logs

@@ -2713,17 +2713,25 @@
  • required: IMDS V2 only
  • optional: IMDS V1 + V2
    • -
    pleco.resources_ttl
    integer
    Deprecated
    Default: -1
    registry.mirroring_mode
    string (RegistryMirroringModeEnum)
    Default: "SERVICE"
    Enum: "CLUSTER" "SERVICE"

    Mirroring mode when deploying a service from a container registry

    +
    pleco.resources_ttl
    integer
    Deprecated
    Default: -1
    registry.mirroring_mode
    string (RegistryMirroringModeEnum)
    Default: "SERVICE"
    Enum: "CLUSTER" "SERVICE"

    Mirroring mode when deploying a service from a container registry

    • CLUSTER: This is not available on Scaleway. Images within the mirroring registry are organized by "Qovery cluster", meaning that the application deployed on the same cluster are all mirrored on the same repository.
    • SERVICE: Images within the mirroring registry are organized by "Qovery service", each service has its own repository
    +
    nginx.vcpu.request_in_milli
    integer
    Default: 100

    vcpu request in millicores

    +
    nginx.vcpu.limit_in_milli
    integer
    Default: 500

    vcpu limit in millicores

    +
    nginx.memory.request_in_mib
    integer
    Default: 768

    memory request in MiB

    +
    nginx.memory.limit_in_mib
    integer
    Default: 768

    memory limit in MiB

    +
    nginx.hpa.cpu_utilization_percentage_threshold
    integer
    Default: 50

    hpa cpu threshold in percentage

    +
    nginx.hpa.memory_utilization_percentage_threshold
    integer
    Default: 50

    hpa memory threshold in percentage

    +
    nginx.hpa.min_number_instances
    integer
    Default: 2

    hpa minimum number of instances

    +
    nginx.hpa.max_number_instances
    integer
    Default: 25

    hpa maximum number of instances

    Responses

    Request samples

    Content type
    application/json
    {
    • "aws.cloudwatch.eks_logs_retention_days": 90,
    • "aws.vpc.enable_s3_flow_logs": false,
    • "aws.vpc.flow_logs_retention_days": 365,
    • "loki.log_retention_in_week": 12,
    • "registry.image_retention_time": 31536000,
    • "cloud_provider.container_registry.tags": {
      },
    • "load_balancer.size": "lb-s",
    • "database.postgresql.deny_public_access": false,
    • "database.postgresql.allowed_cidrs": [
      ],
    • "database.mysql.deny_public_access": false,
    • "database.mysql.allowed_cidrs": [
      ],
    • "database.mongodb.deny_public_access": false,
    • "database.mongodb.allowed_cidrs": [
      ],
    • "database.redis.deny_public_access": false,
    • "database.redis.allowed_cidrs": [
      ],
    • "aws.iam.admin_group": "Admins",
    • "aws.eks.ec2.metadata_imds": "optional",
    • "pleco.resources_ttl": -1,
    • "registry.mirroring_mode": "CLUSTER"
    }

    Response samples

    Content type
    application/json
    {
    • "aws.cloudwatch.eks_logs_retention_days": 90,
    • "aws.vpc.enable_s3_flow_logs": false,
    • "aws.vpc.flow_logs_retention_days": 365,
    • "loki.log_retention_in_week": 12,
    • "registry.image_retention_time": 31536000,
    • "cloud_provider.container_registry.tags": {
      },
    • "load_balancer.size": "lb-s",
    • "database.postgresql.deny_public_access": false,
    • "database.postgresql.allowed_cidrs": [
      ],
    • "database.mysql.deny_public_access": false,
    • "database.mysql.allowed_cidrs": [
      ],
    • "database.mongodb.deny_public_access": false,
    • "database.mongodb.allowed_cidrs": [
      ],
    • "database.redis.deny_public_access": false,
    • "database.redis.allowed_cidrs": [
      ],
    • "aws.iam.admin_group": "Admins",
    • "aws.eks.ec2.metadata_imds": "optional",
    • "pleco.resources_ttl": -1,
    • "registry.mirroring_mode": "CLUSTER"
    }

    Get routing table

    Retrieve network routing table where each line corresponds to a route between a destination and a target.

    +

    Request samples

    Content type
    application/json
    {
    • "aws.cloudwatch.eks_logs_retention_days": 90,
    • "aws.vpc.enable_s3_flow_logs": false,
    • "aws.vpc.flow_logs_retention_days": 365,
    • "loki.log_retention_in_week": 12,
    • "registry.image_retention_time": 31536000,
    • "cloud_provider.container_registry.tags": {
      },
    • "load_balancer.size": "lb-s",
    • "database.postgresql.deny_public_access": false,
    • "database.postgresql.allowed_cidrs": [
      ],
    • "database.mysql.deny_public_access": false,
    • "database.mysql.allowed_cidrs": [
      ],
    • "database.mongodb.deny_public_access": false,
    • "database.mongodb.allowed_cidrs": [
      ],
    • "database.redis.deny_public_access": false,
    • "database.redis.allowed_cidrs": [
      ],
    • "aws.iam.admin_group": "Admins",
    • "aws.eks.ec2.metadata_imds": "optional",
    • "pleco.resources_ttl": -1,
    • "registry.mirroring_mode": "CLUSTER",
    • "nginx.vcpu.request_in_milli": 100,
    • "nginx.vcpu.limit_in_milli": 500,
    • "nginx.memory.request_in_mib": 768,
    • "nginx.memory.limit_in_mib": 768,
    • "nginx.hpa.cpu_utilization_percentage_threshold": 50,
    • "nginx.hpa.memory_utilization_percentage_threshold": 50,
    • "nginx.hpa.min_number_instances": 2,
    • "nginx.hpa.max_number_instances": 25
    }

    Response samples

    Content type
    application/json
    {
    • "aws.cloudwatch.eks_logs_retention_days": 90,
    • "aws.vpc.enable_s3_flow_logs": false,
    • "aws.vpc.flow_logs_retention_days": 365,
    • "loki.log_retention_in_week": 12,
    • "registry.image_retention_time": 31536000,
    • "cloud_provider.container_registry.tags": {
      },
    • "load_balancer.size": "lb-s",
    • "database.postgresql.deny_public_access": false,
    • "database.postgresql.allowed_cidrs": [
      ],
    • "database.mysql.deny_public_access": false,
    • "database.mysql.allowed_cidrs": [
      ],
    • "database.mongodb.deny_public_access": false,
    • "database.mongodb.allowed_cidrs": [
      ],
    • "database.redis.deny_public_access": false,
    • "database.redis.allowed_cidrs": [
      ],
    • "aws.iam.admin_group": "Admins",
    • "aws.eks.ec2.metadata_imds": "optional",
    • "pleco.resources_ttl": -1,
    • "registry.mirroring_mode": "CLUSTER",
    • "nginx.vcpu.request_in_milli": 100,
    • "nginx.vcpu.limit_in_milli": 500,
    • "nginx.memory.request_in_mib": 768,
    • "nginx.memory.limit_in_mib": 768,
    • "nginx.hpa.cpu_utilization_percentage_threshold": 50,
    • "nginx.hpa.memory_utilization_percentage_threshold": 50,
    • "nginx.hpa.min_number_instances": 2,
    • "nginx.hpa.max_number_instances": 25
    }

    Get routing table

    Retrieve network routing table where each line corresponds to a route between a destination and a target.

    Authorizations:
    bearerAuthApiKeyAuth
    path Parameters
    organizationId
    required
    string <uuid>

    Organization ID

    clusterId
    required
    string <uuid>

    Cluster ID

    Responses

    Response samples

    Content type
    application/json
    {
    • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
    • "status": "BUILDING",
    • "is_deployed": true
    }

    List default cluster advanced settings

    Authorizations:
    bearerAuthApiKeyAuth

    Responses

    Response samples

    Content type
    application/json
    {
    • "aws.cloudwatch.eks_logs_retention_days": 90,
    • "aws.vpc.enable_s3_flow_logs": false,
    • "aws.vpc.flow_logs_retention_days": 365,
    • "loki.log_retention_in_week": 12,
    • "registry.image_retention_time": 31536000,
    • "cloud_provider.container_registry.tags": {
      },
    • "load_balancer.size": "lb-s",
    • "database.postgresql.deny_public_access": false,
    • "database.postgresql.allowed_cidrs": [
      ],
    • "database.mysql.deny_public_access": false,
    • "database.mysql.allowed_cidrs": [
      ],
    • "database.mongodb.deny_public_access": false,
    • "database.mongodb.allowed_cidrs": [
      ],
    • "database.redis.deny_public_access": false,
    • "database.redis.allowed_cidrs": [
      ],
    • "aws.iam.admin_group": "Admins",
    • "aws.eks.ec2.metadata_imds": "optional",
    • "pleco.resources_ttl": -1,
    • "registry.mirroring_mode": "CLUSTER"
    }

    Cloud Provider

    List Cloud providers available

    Authorizations:
    bearerAuthApiKeyAuth

    Responses

    Response samples

    Content type
    application/json
    {
    • "aws.cloudwatch.eks_logs_retention_days": 90,
    • "aws.vpc.enable_s3_flow_logs": false,
    • "aws.vpc.flow_logs_retention_days": 365,
    • "loki.log_retention_in_week": 12,
    • "registry.image_retention_time": 31536000,
    • "cloud_provider.container_registry.tags": {
      },
    • "load_balancer.size": "lb-s",
    • "database.postgresql.deny_public_access": false,
    • "database.postgresql.allowed_cidrs": [
      ],
    • "database.mysql.deny_public_access": false,
    • "database.mysql.allowed_cidrs": [
      ],
    • "database.mongodb.deny_public_access": false,
    • "database.mongodb.allowed_cidrs": [
      ],
    • "database.redis.deny_public_access": false,
    • "database.redis.allowed_cidrs": [
      ],
    • "aws.iam.admin_group": "Admins",
    • "aws.eks.ec2.metadata_imds": "optional",
    • "pleco.resources_ttl": -1,
    • "registry.mirroring_mode": "CLUSTER",
    • "nginx.vcpu.request_in_milli": 100,
    • "nginx.vcpu.limit_in_milli": 500,
    • "nginx.memory.request_in_mib": 768,
    • "nginx.memory.limit_in_mib": 768,
    • "nginx.hpa.cpu_utilization_percentage_threshold": 50,
    • "nginx.hpa.memory_utilization_percentage_threshold": 50,
    • "nginx.hpa.min_number_instances": 2,
    • "nginx.hpa.max_number_instances": 25
    }

    Cloud Provider

    List Cloud providers available

    Authorizations:
    bearerAuthApiKeyAuth

    Responses

    Request samples

    Content type
    application/json
    {
    • "first_name": "string",
    • "last_name": "string",
    • "user_email": "string",
    • "type_of_use": "PERSONAL",
    • "qovery_usage": "string",
    • "company_name": "string",
    • "company_size": "1-10",
    • "user_role": "string",
    • "qovery_usage_other": "string",
    • "user_questions": "string",
    • "current_step": "string",
    • "dx_auth": true
    }