MWS Cloud Platform

https://mws.ru/docs
Admin
MWS Cloud Platform offers a suite of cloud services including Identity and Access Management,...
Tokens:1,312,732
Snippets:10,644
Trust Score:8.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Create a Kafka Topic with Terraform

Source: https://mws.ru/docs/cloud-platform/terraform/provider/resources/mkafka_topic.html

This example demonstrates the full setup of a VPC network, subnets, addresses, a Kafka cluster, and finally the Kafka topic resource.

```hcl
resource "mws_vpc_network" "network" {
  network = var.network_name
}

resource "mws_vpc_subnet" "subnet_a" {
  subnet  = "${var.subnet_name}-a"
  network = mws_vpc_network.network.network
  cidr    = var.subnet_cidr_a
}

resource "mws_vpc_subnet" "subnet_b" {
  subnet  = "${var.subnet_name}-b"
  network = mws_vpc_network.network.network
  cidr    = var.subnet_cidr_b
}

resource "mws_vpc_address" "broker_addr_1" {
  address = "${var.kafka_name}-broker-addr-1"
  network = mws_vpc_network.network.network
  subnet  = mws_vpc_subnet.subnet_a.metadata.id
}

resource "mws_vpc_address" "broker_addr_2" {
  address = "${var.kafka_name}-broker-addr-2"
  network = mws_vpc_network.network.network
  subnet  = mws_vpc_subnet.subnet_b.metadata.id
}

resource "mws_vpc_address" "broker_addr_3" {
  address = "${var.kafka_name}-broker-addr-3"
  network = mws_vpc_network.network.network
  subnet  = mws_vpc_subnet.subnet_b.metadata.id
}

resource "mws_mkafka_cluster" "example" {
  cluster = var.kafka_name
  version = "4.0"

  metadata = {
    display_name = "Example Kafka Cluster"
    description  = "Managed Kafka cluster example"
  }

  active = true

  endpoints = [
    {
      name    = "vpc-endpoint"
      network = mws_vpc_network.network.metadata.id
      broker_addresses = [
        { ref = mws_vpc_address.broker_addr_1.id },
        { ref = mws_vpc_address.broker_addr_2.id },
        { ref = mws_vpc_address.broker_addr_3.id }
      ]
    }
  ]

  instances = {
    broker = {
      vm_type = "compute/vmTypes/gen-2-4"
      disk = {
        size = "10Gb"
        type = "NETWORK_STANDARD_SSD"
      }
      allocation = [
        {
          zone  = "ru-central1-b"
          count = 3
        }
      ]
    }
    controller = {
      vm_type = "compute/vmTypes/gen-2-4"
      disk = {
        size = "10Gb"
        type = "NETWORK_STANDARD_SSD"
      }
      allocation = [
        {
          zone  = "ru-central1-b"
          count = 3
        }
      ]
    }
  }

  maintenance_window = {
    weekly = {
      days = ["TUESDAY"]
      hour = 4
    }
  }
}

resource "mws_mkafka_topic" "example" {
  cluster = mws_mkafka_cluster.example.cluster
  topic   = var.topic_name

  metadata = {
    display_name = "Example Kafka Topic"
    description  = "A sample Kafka topic with custom configuration"
  }

  partitions         = 6
  replication_factor = 3

  config = "cleanup.policy = compact"
}

variable "network_name" {
  type        = string
  default     = "kafka-vpc-network"
  description = "VPC network name"
}

variable "subnet_name" {
  type        = string
  default     = "kafka-subnet"
  description = "Base name for subnets"
}

variable "subnet_cidr_a" {
  type        = string
  default     = "192.168.1.0/24"
  description = "CIDR for subnet A"
}

variable "subnet_cidr_b" {
  type        = string
  default     = "192.168.2.0/24"
  description = "CIDR for subnet B"
}

variable "kafka_name" {
  type        = string
  default     = "kafka-cluster"
  description = "Kafka cluster name"
}

variable "topic_name" {
  type        = string
  default     = "example-topic"
  description = "Kafka topic name"
}
```

--------------------------------

### Get Resource Details by Reference

Source: https://mws.ru/docs/cloud-platform/mws-cli/general/whatis-mws-cli.html

Example of retrieving disk information using a resource reference path.

```bash
mws compute disk get projects/example/disks/mydisk
```

--------------------------------

### Example of creating a table

Source: https://mws.ru/docs/cloud-platform/mclickhouse/general/table-operations.html

A concrete example of creating a table using the MergeTree engine.

```sql
CREATE TABLE IF NOT EXISTS my_database.my_table
(
    id UInt64 COMMENT 'Уникальный идентификатор',
    name String,
    created_at DateTime
)
ENGINE = MergeTree
ORDER BY id
COMMENT 'Таблица событий пользователей'
ON CLUSTER 'my_cluster';
```

--------------------------------

### Install AWS CLI via Snap

Source: https://mws.ru/docs/cloud-platform/storage/general/instruments-aws-cli.html

Installation command using the snap package manager.

```bash
1
snap install aws-cli --classic
```

--------------------------------

### Complete Terraform Configuration

Source: https://mws.ru/docs/cloud-platform/terraform/general/terraform-quickstart.html

A full example of a main.tf file including provider setup, network, firewall, disk, and virtual machine resources.

```hcl
terraform {
  required_providers {
    mws = {
      source = "mws-cloud/mws"
    }
  }
  required_version = ">= 1.11"
}

provider "mws" {
  service_account_authorized_key_path = "<путь к файлу с авторизованным ключом>"
  zone      = "ru-central1-a"
  project   = "<имя проекта>"
}

resource "mws_vpc_network" "network" {
  network = "mynetwork"
}

resource "mws_vpc_subnet" "subnet" {
  depends_on = [mws_vpc_network.network]
  subnet     = "mysubnet"
  network    = mws_vpc_network.network.network
  cidr       = "192.168.0.0/16"
}

resource "mws_vpc_firewall_rule" "firewall_rule" {
  metadata = {
    display_name = "Allow SSH"
  }

  firewall_rule = "myrule"
  network       = mws_vpc_network.network.network

  priority  = 1000
  direction = "INGRESS"
  action    = "ALLOW"

  source = {
    spec = {
      cidrs = ["0.0.0.0/0"]
    }
  }

  destination = {
    spec = {
      cidrs = ["${mws_vpc_address.vm_primary_network_interface_address.status.ip_address}/32"]
    }
  }

  proto_ports = ["TCP:22"]
  active      = true
}

data "mws_compute_image" "image" {
  image   = "mws-ubuntu-2204-lts-v20250529"
  project = "mws-ubuntu"
}

resource "mws_vpc_address" "vm_primary_network_interface_address" {
  network = mws_vpc_network.network.network
  subnet  = mws_vpc_subnet.subnet.metadata.id
  address = "my-test-vm-primary-network-interface-address"
}

resource "mws_vpc_external_address" "vm_external_address" {
  external_address = "myvm-external-address"
}

resource "mws_compute_disk" "disk" {
  disk      = "mydisk"
  disk_type = "diskTypes/nbs-pl2"
  iops      = 1000
  size      = "10GB"
  source = {
    image = data.mws_compute_image.image.metadata.id
  }
}

resource "mws_compute_virtual_machine" "vm" {
  virtual_machine = "myvm"
  vm_type         = "vmTypes/gen-2-8"

  hardware = {
    power                     = "ON"
    graceful_shutdown_timeout = "1m 30s"
  }

  os = {
    hostname     = "my"
    local_domain = "vm"

    metadata = {
      user-data = <<-EOF
        #cloud-config
        users:
          - name: myuser
            groups: sudo
            shell: /bin/bash
            sudo: 'ALL=(ALL) NOPASSWD:ALL'
            ssh_authorized_keys:
              - ssh-ed25519 AAAAC4YzaC2lDDI1NFE5FFFFIJXzfUIPxeQW+snH3LYn1t++5bdEzdfd+Mdj0h99Ii20 myuser@mycomputer
      EOF
    }
  }

  storage = {
    disks = [
      {
        name = "boot"
        boot = true
        disk = {
          ref = mws_compute_disk.disk.metadata.id
        }
      }
    ]
  }

  network = {
    network_interfaces = [
      {
        name    = "myvm-network-interface-primary"
        primary = true
        addresses = [
          {
            address = {
              ref = mws_vpc_address.vm_primary_network_interface_address.metadata.id
            }
            one_to_one_nat = {
              external = {
                address = {
                  ref = mws_vpc_external_address.vm_external_address.metadata.id
                }
              }
            }
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Run command output

Source: https://mws.ru/docs/cloud-platform/registry/general/docker-quickstart-registry.html

Example output confirming the image was executed successfully.

```text
Hello from Docker!
This message shows that your installation appears to be working correctly.
```

--------------------------------

### Install Rclone on Linux

Source: https://mws.ru/docs/s3/util-rclone.html

Commands to install Rclone on Linux systems.

```bash
sudo -v ; curl https://rclone.org/install.sh | sudo bash
```

```bash
sudo apt install rclone
```

--------------------------------

### Manage Lifecycle Configuration

Source: https://mws.ru/docs/s3/util-awscli.html

Commands to set, get, or delete bucket lifecycle policies.

```bash
aws s3api put-bucket lifecycle –bucket <имя_бакета> –lifecycle-configuration file://<имя_файла_конфигурации>.json --endpoint-url=<endpoint>
```

```bash
aws s3api get-bucket lifecycle –bucket <имя_бакета> --endpoint-url=<endpoint>
```

```bash
aws s3api delete-bucket lifecycle –bucket <имя_бакета> --endpoint-url=<endpoint>
```

--------------------------------

### Manage CORS Configuration

Source: https://mws.ru/docs/s3/util-awscli.html

Commands to set, get, or delete bucket CORS policies.

```bash
aws s3api put-bucket-cors –bucket <имя_бакета> –cors-configuration file://<имя_файла_конфигурации>.xml --endpoint-url=<endpoint>
```

```bash
aws s3api get-bucket-cors –bucket <имя_бакета> --endpoint-url=<endpoint>
```

```bash
aws s3api delete-bucket-cors –bucket <имя_бакета> --endpoint-url=<endpoint>
```

--------------------------------

### Example HTTP Request with Origin Header

Source: https://mws.ru/docs/cdn/cdn-httpheaders.html

An example of an HTTP GET request sent by a browser, including the Origin header used in the CORS mechanism.

```http
1
GET /image HTTP/1.1
2
Host: mydomain2.com
3
User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre
4
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
5
Accept-Language: en-us,en;q=0.5
6
Accept-Encoding: gzip,deflate
7
Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
8
Connection: keep-alive
9
Referer: http://mydomain1.com/examples/access-control/test.html
10
Origin: http://mydomain.com
```

--------------------------------

### Disk Creation Command Output

Source: https://mws.ru/docs/cloud-platform/compute/general/disks-create-delete.html

Example response metadata and specification returned after successfully creating a disk.

```yaml
1
metadata:
2
    createTime: "2025-06-24T03:27:40Z"
3
    etag: 37d65a33398f40c4ab12ac0107f42aa3
4
    id: projects/<имя проекта>/disks/<имя диска>
5
    name: <имя диска>
6
    updateTime: "2025-06-24T03:27:40Z"
7
    usages: []
8
spec:
9
    diskType: nbs-pl2
10
    iops: 1000
11
    size: 10GB
12
    zone: ru-central1-a
13
status:
14
    blockSize: 4096 B
15
    diskType: compute/diskTypes/nbs-pl2
16
    iops:
17
        base: 1000
18
        extra: 0
19
        total: 1000
20
    linkedVms: []
21
    ready:
22
        state: PROCESSING
23
    size: 10GB
24
    throughput: 33554432 Bps
```

--------------------------------

### Инициализация Go-проекта

Source: https://mws.ru/docs/cloud-platform/sdk/general/go-sdk-quickstart.html

Создание директории и инициализация модуля для работы с SDK.

```bash
mkdir my-project
cd my-project
go mod init my-project
```

--------------------------------

### Конвертация образа из qcow2 в vmdk

Source: https://mws.ru/docs/computecloud/images.html

Используйте утилиту qemu-img для преобразования образа в формат, совместимый с Compute Cloud. Требуется установленный пакет qemu.

```bash
qemu-img convert -p -f qcow2 -O vmdk -o adapter_type=lsilogic,subformat=streamOptimized,compat6 in.qcow2 out.vmdk
```

--------------------------------

### Terraform configuration for Managed Kubernetes cluster and node group

Source: https://mws.ru/docs/cloud-platform/terraform/provider/resources/mk8s_node_group.html

This example demonstrates the full setup of a VPC network, subnets, service account, Kubernetes cluster, and a node group with autoscaling and maintenance configurations.

```hcl
1
resource "mws_vpc_network" "network" {
2
  network = var.network_name
3
}
4


5
resource "mws_vpc_subnet" "subnet_a" {
6
  subnet  = "${var.subnet_name}-a"
7
  network = mws_vpc_network.network.network
8
  cidr    = var.subnet_cidr_a
9
}
10


11
resource "mws_vpc_subnet" "subnet_b" {
12
  subnet  = "${var.subnet_name}-b"
13
  network = mws_vpc_network.network.network
14
  cidr    = var.subnet_cidr_b
15
}
16


17
resource "mws_vpc_address" "address" {
18
  address = var.address_name
19
  network = mws_vpc_network.network.network
20
  subnet  = mws_vpc_subnet.subnet_a.metadata.id
21
}
22


23
resource "mws_iam_service_account" "sa" {
24
  service_account = var.service_account_name
25
}
26


27
resource "mws_mk8s_cluster" "example" {
28
  availability = {
29
    zonal_ha = { // zonal high available
30
      zone = "ru-central1-b"
31
    }
32
  }
33


34
  cluster_name = var.cluster_name
35


36
  metadata = {
37
    description  = "Zonal HA Kubernetes cluster"
38
    display_name = "HA Example Cluster"
39
  }
40


41
  network = {
42
    pods_cidr     = var.pods_cidr
43
    services_cidr = var.services_cidr
44
    primary_endpoint = {
45
      ref = mws_vpc_address.address.id
46
    }
47
  }
48


49
  version_control = {
50
    release_channel = "stable"
51
    maintenance_window = {
52
      weekly = {
53
        days = ["MONDAY", "WEDNESDAY"]
54
        hour = 3
55
      }
56
    }
57
    version = "v1.35.6-mws.4"
58
  }
59
}
60


61
resource "mws_mk8s_node_group" "example" {
62
  cluster_name    = mws_mk8s_cluster.example.cluster_name
63
  node_group_name = "${var.cluster_name}-example-node-group"
64


65
  service_account = {
66
    ref = mws_iam_service_account.sa.metadata.id
67
  }
68


69
  subnet = {
70
    ref = mws_vpc_subnet.subnet_a.metadata.id
71
  }
72


73
  vm_type = {
74
    ref = "compute/vmTypes/gen-2-8"
75
  }
76


77
  scale = {
78
    autoscaling = {
79
      min = 1
80
      max = 3
81
    }
82
  }
83


84
  rollout_strategy = {
85
    max_surge       = 1
86
    max_unavailable = 0
87
  }
88


89
  version_control = {
90
    auto_update = true
91
    version     = "v1.35.6-mws.4"
92
    maintenance_window = {
93
      weekly = {
94
        days     = ["MONDAY", "WEDNESDAY"]
95
        hour     = 3
96
        duration = "4h"
97
      }
98
    }
99
  }
100


101
  image_storage_size = "20Gb"
102


103
  labels = [
104
    { key = "environment", value = "production" },
105
    { key = "team", value = "devops" }
106
  ]
107


108
  taints = []
109


110
  zone = "ru-central1-a"
111
}
112


113
variable "network_name" {
114
  type        = string
115
  default     = "my-ha-network"
116
  description = "VPC network name"
117
}
118


119
variable "subnet_name" {
120
  type        = string
121
  default     = "my-ha-subnet"
122
  description = "Base name for subnets"
123
}
124


125
variable "subnet_cidr_a" {
126
  type        = string
127
  default     = "192.168.0.0/17"
128
  description = "CIDR for subnet A"
129
}
130


131
variable "subnet_cidr_b" {
132
  type        = string
133
  default     = "192.168.128.0/17"
134
  description = "CIDR for subnet B"
135
}
136


137
variable "address_name" {
138
  type        = string
139
  default     = "k8s-primary-ip"
140
  description = "Name for the primary endpoint address"
141
}
142


143
variable "service_account_name" {
144
  type        = string
145
  default     = "my-service-account"
146
  description = "Service account name"
147
}
148


149
variable "cluster_name" {
150
  type        = string
151
  default     = "ha-k8s-cluster"
152
  description = "Name of the Kubernetes cluster"
153
}
154


155
variable "pods_cidr" {
156
  type        = string
157
  default     = "10.244.0.0/16"
158
  description = "Pods CIDR block"
159
}
160


161
variable "services_cidr" {
162
  type        = string
163
  default     = "10.96.0.0/16"
164
  description = "Services CIDR block"
165
}
```

--------------------------------

### Apply Manifest and Verify Deployment

Source: https://mws.ru/docs/cloud-platform/mk8s/general/registry-usage.html

Commands to apply the configuration and check the status of the running pods.

```bash
kubectl apply -f nginx-deployment.yaml
```

```bash
kubectl get pods -l app=nginx
```

--------------------------------

### Example authorization code

Source: https://mws.ru/docs/cloud-platform/mws-cli/general/quickstart-mws-cli.html

An example of the authorization code obtained after authenticating in the browser.

```text
58a33570-fcf5-4c63-93ff-5db69118b74e
```

--------------------------------

### Deploying a Virtual Machine with Terraform

Source: https://mws.ru/docs/cloud-platform/terraform/provider/resources/compute_virtual_machine.html

A complete configuration example showing the creation of a virtual machine, including network interfaces, storage, and necessary infrastructure dependencies.

```hcl
1
data "mws_compute_image" "image" {
2
  image   = "mws-ubuntu-2204-lts-v20250529"
3
  project = "mws-ubuntu"
4
}
5


6
resource "mws_vpc_network" "network" {
7
  network = var.network_name
8
}
9


10
resource "mws_vpc_subnet" "subnet" {
11
  subnet  = var.subnet_name
12
  network = mws_vpc_network.network.network
13
  cidr    = "192.168.0.0/16"
14
}
15


16
resource "mws_vpc_address" "vm_primary_network_interface_address" {
17
  network = mws_vpc_network.network.network
18
  subnet  = mws_vpc_subnet.subnet.metadata.id
19
  address = "${var.vm_name}-primary-network-interface-address"
20
}
21


22
resource "mws_vpc_external_address" "vm_external_address" {
23
  external_address = "${var.vm_name}-external-address"
24
}
25


26
resource "mws_compute_disk" "disk" {
27
  disk      = var.disk_name
28
  disk_type = "diskTypes/nbs-pl2"
29
  iops      = 1000
30
  size      = "10GB"
31
  source = {
32
    image = data.mws_compute_image.image.metadata.id
33
  }
34
}
35


36
resource "mws_compute_virtual_machine" "vm" {
37
  virtual_machine = var.vm_name
38
  vm_type         = "vmTypes/gen-2-8"
39

40
  hardware = {
41
    power                     = "ON"
42
    graceful_shutdown_timeout = "1m 30s"
43
  }
44

45
  storage = {
46
    disks = [
47
      {
48
        name = "boot"
49
        boot = true
50
        disk = {
51
          ref = mws_compute_disk.disk.metadata.id
52
        }
53
      }
54
    ]
55
  }
56

57
  network = {
58
    network_interfaces = [
59
      {
60
        name    = "${var.vm_name}-network-interface-primary"
61
        primary = true
62
        addresses = [
63
          {
64
            address = {
65
              ref = mws_vpc_address.vm_primary_network_interface_address.metadata.id
66
            }
67
            one_to_one_nat = {
68
              external = {
69
                address = {
70
                  ref = mws_vpc_external_address.vm_external_address.metadata.id
71
                }
72
              }
73
            }
74
          }
75
        ]
76
      }
77
    ]
78
  }
79
}
80


81
variable "vm_name" {
82
  type        = string
83
  default     = "my-test-vm"
84
  description = "Virtual machine name"
85
}
86


87
variable "network_name" {
88
  type        = string
89
  default     = "my-test-network"
90
  description = "Network name"
91
}
92


93
variable "subnet_name" {
94
  type        = string
95
  default     = "my-test-subnet"
96
  description = "Subnet name"
97
}
98


99
variable "disk_name" {
100
  type        = string
101
  default     = "my-test-disk"
102
  description = "Disk name"
103
}
```

--------------------------------

### Run Replication Process

Source: https://mws.ru/docs/cloud-platform/mpostgres/general/data-migration.html

Initiate the database cloning and replication process.

```bash
pgcopydb clone --follow --no-owner --skip-extensions --skip-db-properties --no-role-passwords --drop-if-exists
```

--------------------------------

### Verify Terraform Installation

Source: https://mws.ru/docs/cloud-platform/terraform/general/terraform-troubleshooting.html

Check the installed version of Terraform to verify that the PATH is configured correctly.

```bash
terraform -v
```

--------------------------------

### Push command output

Source: https://mws.ru/docs/cloud-platform/registry/general/docker-quickstart-registry.html

Example output showing a successful image push to the registry.

```text
The push refers to repository [registry.mwsapis.ru/<имя проекта>/<имя реестра>/hello-world]
63a41026379f: Pushed
init: digest: sha256:7565f2c7034d87673c5ddc3b1b8e17f8da794c31d9aa73ed26afffa1c8194889 size: 524
```

--------------------------------

### Install AWS CLI via Brew

Source: https://mws.ru/docs/cloud-platform/storage/general/instruments-aws-cli.html

Installation command using the Homebrew package manager.

```bash
1
brew install awscli
```

--------------------------------

### Install AWS CLI on MacOS

Source: https://mws.ru/docs/cloud-platform/storage/general/instruments-aws-cli.html

Commands to download and install the AWS CLI package on MacOS.

```bash
1
curl "https://awscli.amazonaws.com/AWSCLIV2.pkg" -o "AWSCLIV2.pkg"
2
sudo installer -pkg AWSCLIV2.pkg -target /
```

--------------------------------

### Deploy and Verify Resources

Source: https://mws.ru/docs/cloud-platform/mk8s/general/velero.html

Commands to apply the manifest and verify the status of pods and persistent volume claims.

```bash
kubectl apply -f myapp.yaml
```

```bash
kubectl get pods -l app=test-app && \
kubectl get pvc test-pvc
```

```bash
NAME                        READY   STATUS    RESTARTS   AGE
test-app-7bf57b58b8-jnxqf   1/1     Running   0          2m30s
NAME       STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   VOLUMEATTRIBUTESCLASS   AGE
test-pvc   Bound    pvc-c81a3ea4-cfe6-4703-bd00-ddb349a977f3   1Gi        RWO            mws            <unset>                 2m31s
```

--------------------------------

### Install Virtio Guest Tools

Source: https://mws.ru/docs/cloud-platform/compute/general/images-upload-windows.html

Executes the Virtio guest tools installer from the mounted drive.

```powershell
Start-Process -FilePath "E:\virtio-win-guest-tools.exe" -Wait
```

--------------------------------

### Initialize Rclone configuration

Source: https://mws.ru/docs/cloud-platform/storage/general/instruments-rclone.html

Starts the interactive configuration wizard to set up a new remote storage connection.

```bash
rclone config
```

--------------------------------

### POST /mclickhouse/v1/projects/{project_id}/clusters/{cluster_id}:start

Source: https://mws.ru/docs/cloud-platform/mclickhouse/general/cluster-operations.html

Starts a stopped Managed ClickHouse cluster.

```APIDOC
## POST /mclickhouse/v1/projects/{project_id}/clusters/{cluster_id}:start

### Description
Starts a specified Managed ClickHouse cluster within a project.

### Method
POST

### Endpoint
https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера>:start

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The identifier of the project.
- **cluster_id** (string) - Required - The name of the cluster to start.

### Response
#### Success Response (200)
- **cluster_details** (object) - Returns the updated parameters of the cluster.
```
Tokens:
Raw