Update documentation

vk-cs · Nov 3, 2023 · 1e5102d · 1e5102d
1 parent 6b9c3b7
commit 1e5102d
Show file tree

Hide file tree

Showing 16 changed files with 50 additions and 130 deletions.
diff --git a/docs/data-sources/networking_floatingip.md b/docs/data-sources/networking_floatingip.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_floatingip"
 description: |-

diff --git a/docs/data-sources/networking_network.md b/docs/data-sources/networking_network.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_network"
 description: |-

diff --git a/docs/data-sources/networking_port.md b/docs/data-sources/networking_port.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_port"
 description: |-

diff --git a/docs/data-sources/networking_router.md b/docs/data-sources/networking_router.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_router"
 description: |-

diff --git a/docs/data-sources/networking_subnet.md b/docs/data-sources/networking_subnet.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_subnet"
 description: |-

diff --git a/docs/resources/kubernetes_cluster.md b/docs/resources/kubernetes_cluster.md
@@ -90,7 +90,7 @@ resource "vkcs_kubernetes_cluster" "k8s-cluster" {
 
 ## Attributes Reference
 In addition to all arguments above, the following attributes are exported:
-- `all_labels` *map of* *string* &rarr;  The read-only map of all cluster labels. **New since v0.5.1**.
+- `all_labels` *map of* *string* &rarr;  The read-only map of all cluster labels.<br>**New since v0.5.1**.
 
 - `api_address` *string* &rarr;  COE API address.
 

diff --git a/docs/resources/networking_floatingip.md b/docs/resources/networking_floatingip.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_floatingip"
 description: |-

diff --git a/docs/resources/networking_floatingip_associate.md b/docs/resources/networking_floatingip_associate.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_floatingip_associate"
 description: |-

diff --git a/docs/resources/networking_network.md b/docs/resources/networking_network.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_network"
 description: |-
@@ -12,48 +12,9 @@ Manages a network resource within VKCS.
 
 ## Example Usage
 ```terraform
-resource "vkcs_networking_network" "network_1" {
-  name           = "network_1"
-  admin_state_up = "true"
-}
-
-resource "vkcs_networking_subnet" "subnet_1" {
-  name       = "subnet_1"
-  network_id = "${vkcs_networking_network.network_1.id}"
-  cidr       = "192.168.199.0/24"
-}
-
-resource "vkcs_compute_secgroup" "secgroup_1" {
-  name        = "secgroup_1"
-  description = "a security group"
-
-  rule {
-    from_port   = 22
-    to_port     = 22
-    ip_protocol = "tcp"
-    cidr        = "0.0.0.0/0"
-  }
-}
-
-resource "vkcs_networking_port" "port_1" {
-  name               = "port_1"
-  network_id         = "${vkcs_networking_network.network_1.id}"
-  admin_state_up     = "true"
-  security_group_ids = ["${vkcs_compute_secgroup.secgroup_1.id}"]
-
-  fixed_ip {
-    "subnet_id"  = "${vkcs_networking_subnet.subnet_1.id}"
-    "ip_address" = "192.168.199.10"
-  }
-}
-
-resource "vkcs_compute_instance" "instance_1" {
-  name            = "instance_1"
-  security_groups = ["${vkcs_compute_secgroup.secgroup_1.name}"]
-
-  network {
-    port = "${vkcs_networking_port.port_1.id}"
-  }
+resource "vkcs_networking_network" "app" {
+  name        = "app-tf-example"
+  description = "Application network"
 }
 ```
 ## Argument Reference

diff --git a/docs/resources/networking_port.md b/docs/resources/networking_port.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_port"
 description: |-

diff --git a/docs/resources/networking_port_secgroup_associate.md b/docs/resources/networking_port_secgroup_associate.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_port_secgroup_associate"
 description: |-

diff --git a/docs/resources/networking_router.md b/docs/resources/networking_router.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_router"
 description: |-
@@ -12,10 +12,10 @@ Manages a router resource within VKCS.
 
 ## Example Usage
 ```terraform
-resource "vkcs_networking_router" "router_1" {
-  name                = "my_router"
-  admin_state_up      = true
-  external_network_id = "f67f0d72-0ddf-11e4-9d95-e1f29f417e2f"
+resource "vkcs_networking_router" "router" {
+  name = "router-tf-example"
+  # Connect router to Internet
+  external_network_id = data.vkcs_networking_network.extnet.id
 }
 ```
 

diff --git a/docs/resources/networking_router_interface.md b/docs/resources/networking_router_interface.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_router_interface"
 description: |-
@@ -12,24 +12,9 @@ Manages a router interface resource within VKCS.
 
 ## Example Usage
 ```terraform
-resource "vkcs_networking_network" "network_1" {
-  name           = "tf_test_network"
-  admin_state_up = "true"
-}
-
-resource "vkcs_networking_subnet" "subnet_1" {
-  network_id = "${vkcs_networking_network.network_1.id}"
-  cidr       = "192.168.199.0/24"
-}
-
-resource "vkcs_networking_router" "router_1" {
-  name                = "my_router"
-  external_network_id = "f67f0d72-0ddf-11e4-9d95-e1f29f417e2f"
-}
-
-resource "vkcs_networking_router_interface" "router_interface_1" {
-  router_id = "${vkcs_networking_router.router_1.id}"
-  subnet_id = "${vkcs_networking_subnet.subnet_1.id}"
+resource "vkcs_networking_router_interface" "app" {
+  router_id = vkcs_networking_router.router.id
+  subnet_id = vkcs_networking_subnet.app.id
 }
 ```
 

diff --git a/docs/resources/networking_router_route.md b/docs/resources/networking_router_route.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_router_route"
 description: |-
@@ -12,34 +12,12 @@ Creates a routing entry on a VKCS router.
 
 ## Example Usage
 ```terraform
-resource "vkcs_networking_router" "router_1" {
-  name           = "router_1"
-  admin_state_up = "true"
-}
-
-resource "vkcs_networking_network" "network_1" {
-  name           = "network_1"
-  admin_state_up = "true"
-}
-
-resource "vkcs_networking_subnet" "subnet_1" {
-  network_id = "${vkcs_networking_network.network_1.id}"
-  cidr       = "192.168.199.0/24"
-}
-
-resource "vkcs_networking_router_interface" "int_1" {
-  router_id = "${vkcs_networking_router.router_1.id}"
-  subnet_id = "${vkcs_networking_subnet.subnet_1.id}"
-}
-
-resource "vkcs_networking_router_route" "router_route_1" {
-  depends_on       = ["vkcs_networking_router_interface.int_1"]
-  router_id        = "${vkcs_networking_router.router_1.id}"
-  destination_cidr = "10.0.1.0/24"
-  next_hop         = "192.168.199.254"
+resource "vkcs_networking_router_route" "compute_gateway" {
+  router_id        = vkcs_networking_router.router.id
+  destination_cidr = "10.10.0.0/23"
+  next_hop         = vkcs_compute_instance.gateway.access_ip_v4
 }
 ```
-
 ## Argument Reference
 - `destination_cidr` **required** *string* &rarr;  CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
 

diff --git a/docs/resources/networking_subnet.md b/docs/resources/networking_subnet.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_subnet"
 description: |-
@@ -12,14 +12,25 @@ Manages a subnet resource within VKCS.
 
 ## Example Usage
 ```terraform
-resource "vkcs_networking_network" "network_1" {
-  name           = "tf_test_network"
-  admin_state_up = "true"
+resource "vkcs_networking_subnet" "app" {
+  name       = "app-tf-example"
+  network_id = vkcs_networking_network.app.id
+  cidr       = "192.168.199.0/24"
 }
+```
 
-resource "vkcs_networking_subnet" "subnet_1" {
-  network_id = "${vkcs_networking_network.network_1.id}"
-  cidr       = "192.168.199.0/24"
+## Subnet with not default DNS servers
+```terraform
+resource "vkcs_networking_subnet" "subnet-with-dns-tf-example" {
+  name       = "subnet-with-dns-tf-example"
+  network_id = vkcs_networking_network.app.id
+  # here we set DNS'es instead of built in ones.
+  # subnet resources will not be available via their private DNS names.
+  dns_nameservers = [
+    "8.8.8.8",
+    "8.8.4.4"
+  ]
+  cidr = "192.168.200.0/24"
 }
 ```
 ## Argument Reference

diff --git a/docs/resources/networking_subnet_route.md b/docs/resources/networking_subnet_route.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Network"
+subcategory: "Networking"
 layout: "vkcs"
 page_title: "vkcs: vkcs_networking_subnet_route"
 description: |-
@@ -12,25 +12,10 @@ Creates a routing entry on a VKCS subnet.
 
 ## Example Usage
 ```terraform
-resource "vkcs_networking_router" "router_1" {
-  name           = "router_1"
-  admin_state_up = "true"
-}
-
-resource "vkcs_networking_network" "network_1" {
-  name           = "network_1"
-  admin_state_up = "true"
-}
-
-resource "vkcs_networking_subnet" "subnet_1" {
-  network_id = "${vkcs_networking_network.network_1.id}"
-  cidr       = "192.168.199.0/24"
-}
-
-resource "vkcs_networking_subnet_route" "subnet_route_1" {
-  subnet_id        = "${vkcs_networking_subnet.subnet_1.id}"
+resource "vkcs_networking_subnet_route" "subnet-route-to-external-tf-example" {
+  subnet_id        = vkcs_networking_subnet.app.id
   destination_cidr = "10.0.1.0/24"
-  next_hop         = "192.168.199.254"
+  next_hop         = vkcs_networking_port.persistent_etcd.all_fixed_ips[0]
 }
 ```
 ## Argument Reference