Update documentation

.gitattributes

@@ -0,0 +1 @@
+* text eol=lf

.github/workflows/changelog.yml

@@ -3,12 +3,13 @@ on:
   pull_request:
     paths:
       - 'vkcs/**'
+      - '!vkcs/**_test.go'
 jobs:
   error:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: tj-actions/changed-files@v23.1
+      - uses: tj-actions/changed-files@v35
         id: changelog
         with:
           files: |

.github/workflows/golangci-lint.yml

@@ -13,12 +13,12 @@ jobs:
   go-mod:
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
       - name: Install Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
           go-version: 1.18
-      - name: Checkout code
-        uses: actions/checkout@v2
       - name: Check go mod
         run: |
           go mod tidy
@@ -28,9 +28,13 @@ jobs:
   golangci-lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+      - name: Install Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.18
       - name: lint
-        uses: golangci/golangci-lint-action@v2.5.2
+        uses: golangci/golangci-lint-action@v3
         with:
           version: latest
           # skip cache because of flaky behaviors
@@ -41,23 +45,22 @@ jobs:
     needs: golangci-lint # run after golangci-lint action to not produce duplicated errors
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
-          go-version: 1.18 # test only the latest go version to speed up CI
+          go-version: 1.18 # test only release go version to speed up CI
       - name: Run tests
         run: make.exe test
-        continue-on-error: true
   tests-on-macos:
     needs: golangci-lint # run after golangci-lint action to not produce duplicated errors
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
-          go-version: 1.18 # test only the latest go version to speed up CI
+          go-version: 1.18 # test only release go version to speed up CI
       - name: Run tests
         run: make test
   tests-on-unix:
@@ -66,19 +69,13 @@ jobs:
     strategy:
       matrix:
         golang:
-          - 1.17
           - 1.18
+          - 1.19
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
           go-version: ${{ matrix.golang }}
-      - uses: actions/[email protected]
-        with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ matrix.golang }}-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-${{ matrix.golang }}-
       - name: Run tests
-        run: make test
+        run: make test

.github/workflows/release.yml

@@ -20,13 +20,13 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v3
       -
         name: Unshallow
         run: git fetch --prune --unshallow
       -
         name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
           go-version: 1.18
       -
@@ -42,10 +42,10 @@ jobs:
         run: CURRENT_TAG=$(git describe --abbrev=0 --match='v*.*.*' --tags); PREVIOUS_TAG=$(git describe --abbrev=0 --exclude="$CURRENT_TAG" --match='v*.*.*' --tags); sed -n -e "0,/#### $CURRENT_TAG/d" -e "/#### $PREVIOUS_TAG/q;p" CHANGELOG.md > release-notes.txt
       -
         name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v2.5.0
+        uses: goreleaser/goreleaser-action@v4
         with:
           version: latest
-          args: release --rm-dist  --release-notes=release-notes.txt
+          args: release --clean --release-notes=release-notes.txt
         env:
           GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}
           # GitHub sets this automatically

CHANGELOG.md

@@ -7,7 +7,45 @@ description: |-
 
 # VKCS Provider's changelog
 
-#### v0.1.13 (unreleased)
+#### v0.2.1
+- Support shards/instances/volumes resizing in DB cluster with shards
+- Fix reading state of DB cluster with shards
+
+#### v0.2.0
+- Provide support for Public DNS service
+- Add datasources for DB datastores
+- Add datasources for DB datastore capabilities and configuration parameters
+- Support cloud monitoring for DB instances/clusters
+- Add security_group argument to DB instance/cluster resources
+- Fix searching of shared network with datasource
+
+#### v0.1.16
+- Add config option to run against clouds with old cloud containers API
+
+#### v0.1.15
+- Fix error of incorrect setting a value of resource_vkcs_compute_instance.access_ip_v4 to an empty string
+- Add "subnet_id" argument to resource_vkcs_db_instance.network, resource_vkcs_db_cluster.network, and resource_vkcs_db_cluster_with_shards.shard.network
+- Add a warning that is thrown when arguments "network.fixed_ip_v4" and "replica_of" of resource_vkcs_db_instance are set simultaneously
+- Deprecate "port" argument of resource_vkcs_db_instance.network, resource_vkcs_db_cluster.network, and resource_vkcs_db_cluster_with_shards.shard.network
+- Fix error of not resolving referenced network resources that were created with sdn = "sprut"
+- Deprecate "security_group_ids" argument of resource_vkcs_lb_loadbalancer
+- Add "instances" computed attribute to resource_vkcs_db_cluster_with_shards.shard
+- Add "loadbalancer_id" computed attribute to resource_vkcs_db_cluster
+- Fix error of not expecting "retyping" status when modifying resource_vkcs_blockstorage_volume.volume_type
+- Add vkcs_lb_loadbalancer datasource
+- Make "export_location_path" attribute of data_source_vkcs_sharedfilesystem_share computed
+- Add "export_location_path" computed attribute to resource_vkcs_sharedfilesystem_share
+- Fix error of ignoring "restore_point" argument in resource_vkcs_db_instance and resource_vkcs_db_cluster
+
+#### v0.1.14
+- Add "instances" computed field to resource_vkcs_kubernetes_cluster
+- Add ability to control which cluster instances should remain after shrinking cluster via "shrink_options" field of resource_vkcs_kubernetes_cluster
+- Add "ip" computed field to resource_vkcs_db_instance
+- Allow creation of resource_vkcs_images_image in clouds without s3 support
+- Added description for cluster_node_volume_type labels field in resource_vkcs_kubernetes_cluster
+
+#### v0.1.13
+- Updated description for labels field in resource_vkcs_kubernetes_cluster 
 - Added conflicts_with property to remote_group_id and remote_ip_prefix fields of resource_vkcs_networking_secgroup_rule
 - Added deprecation warning to ethertype field of resource_vkcs_networking_secgroup_rule
 - Removed dns_name and dns_domain attributes from resource_vkcs_networking_floatingip

README.md

@@ -22,7 +22,7 @@ $ terraform plan
 
 Provider development
 --------------------
-To start improve it grab the repository, build it and install into local registry repository.
+To start improving grab the repository, build it and install into local registry repository.
 Builds for MacOS, Windows and Linux are available.
 The example is for MacOS.
 ```sh
@@ -47,8 +47,18 @@ EOF
 $ terraform init
 ```
 
+When submitting PR make sure that if golang code has been changed, PR has updates to CHANGELOG.md. Add description of changes under last version with "(unreleased)" mark.
+
+Documenting provider
+--------------------
+To update documentation contents, please, update "description" field of necessary resource/data_source schema and create/modify documentation templates.
+Documentation templates are located in templates/ folder.
+PR with renewed provider documentation is generated automatically when updates are merged into master branch.
+
 Publishing provider
 -------------------
+Before publishing, remove "(unreleased)" mark from CHANGELOG in separate PR. After this PR is merged, you can publish the provider.
+
 Provider publishes via action [release](https://github.com/vk-cs/terraform-provider-vkcs/blob/master/.github/workflows/release.yml).
 To call the action create new tag.
 ```sh

docs/data-sources/vkcs_blockstorage_snapshot.md

@@ -31,16 +31,7 @@ data "vkcs_blockstorage_snapshot" "snapshot_1" {
 
 
 ## Attributes Reference
-- `most_recent` **Boolean** See Argument Reference above.
-
-- `name` **String** See Argument Reference above.
-
-- `region` **String** See Argument Reference above.
-
-- `status` **String** See Argument Reference above.
-
-- `volume_id` **String** See Argument Reference above.
-
+In addition to all arguments above, the following attributes are exported:
 - `description` **String** The snapshot's description.
 
 - `id` **String** ID of the resource.

docs/data-sources/vkcs_blockstorage_volume.md

@@ -32,18 +32,7 @@ data "vkcs_blockstorage_volume" "volume_1" {
 
 
 ## Attributes Reference
-- `bootable` **String** See Argument Reference above.
-
-- `metadata` <strong>Map of </strong>**String** See Argument Reference above.
-
-- `name` **String** See Argument Reference above.
-
-- `region` **String** See Argument Reference above.
-
-- `status` **String** See Argument Reference above.
-
-- `volume_type` **String** See Argument Reference above.
-
+In addition to all arguments above, the following attributes are exported:
 - `availability_zone` **String** The name of the availability zone of the volume.
 
 - `id` **String** ID of the resource.

docs/data-sources/vkcs_compute_availability_zones.md

@@ -22,10 +22,7 @@ data "vkcs_compute_availability_zones" "zones" {}
 
 
 ## Attributes Reference
-- `region` **String** See Argument Reference above.
-
-- `state` **String** See Argument Reference above.
-
+In addition to all arguments above, the following attributes are exported:
 - `id` **String** Hash of the returned zone list.
 
 - `names` **String** The names of the availability zones, ordered alphanumerically, that match the queried `state`

docs/data-sources/vkcs_compute_flavor.md

@@ -43,28 +43,7 @@ data "vkcs_compute_flavor" "small" {
 
 
 ## Attributes Reference
-- `disk` **Number** See Argument Reference above.
-
-- `flavor_id` **String** See Argument Reference above.
-
-- `is_public` **Boolean** See Argument Reference above.
-
-- `min_disk` **Number** See Argument Reference above.
-
-- `min_ram` **Number** See Argument Reference above.
-
-- `name` **String** See Argument Reference above.
-
-- `ram` **Number** See Argument Reference above.
-
-- `region` **String** See Argument Reference above.
-
-- `rx_tx_factor` **Number** See Argument Reference above.
-
-- `swap` **Number** See Argument Reference above.
-
-- `vcpus` **Number** See Argument Reference above.
-
+In addition to all arguments above, the following attributes are exported:
 - `extra_specs` <strong>Map of </strong>**String** Key/Value pairs of metadata for the flavor.
 
 - `id` **String** ID of the found flavor.

docs/data-sources/vkcs_compute_instance.md

@@ -27,12 +27,7 @@ data "vkcs_compute_instance" "instance" {
 
 
 ## Attributes Reference
-- `id` **String** See Argument Reference above.
-
-- `region` **String** See Argument Reference above.
-
-- `user_data` **String** See Argument Reference above.
-
+In addition to all arguments above, the following attributes are exported:
 - `access_ip_v4` **String** The first IPv4 address assigned to this server.
 
 - `availability_zone` **String** The availability zone of this server.

docs/data-sources/vkcs_compute_keypair.md

@@ -24,10 +24,7 @@ data "vkcs_compute_keypair" "kp" {
 
 
 ## Attributes Reference
-- `name` **String** See Argument Reference above.
-
-- `region` **String** See Argument Reference above.
-
+In addition to all arguments above, the following attributes are exported:
 - `fingerprint` **String** The fingerprint of the OpenSSH key.
 
 - `id` **String** ID of the resource.

docs/data-sources/vkcs_compute_quotaset.md

@@ -24,10 +24,7 @@ data "vkcs_compute_quotaset" "quota" {
 
 
 ## Attributes Reference
-- `project_id` **String** See Argument Reference above.
-
-- `region` **String** See Argument Reference above.
-
+In addition to all arguments above, the following attributes are exported:
 - `cores` **Number** The number of allowed server cores.
 
 - `id` **String** ID of the resource.

docs/data-sources/vkcs_db_backup.md

@@ -24,10 +24,7 @@ data "vkcs_db_backup" "db-backup" {
 
 
 ## Attributes Reference
-- `backup_id` **String** See Argument Reference above.
-
-- `description` **String** See Argument Reference above.
-
+In addition to all arguments above, the following attributes are exported:
 - `created` **String** Backup creation timestamp
 
 - `datastore` **Object** Object that represents datastore of backup

docs/data-sources/vkcs_db_config_group.md

@@ -23,8 +23,7 @@ data "vkcs_db_config_group" "db-config-group" {
 
 
 ## Attributes Reference
-- `config_group_id` **String** See Argument Reference above.
-
+In addition to all arguments above, the following attributes are exported:
 - `created` **String** Timestamp of config group's creation.
 
 - `datastore` **Object** Object that represents datastore of backup

docs/data-sources/vkcs_db_database.md

@@ -30,14 +30,5 @@ data "vkcs_db_database" "db-database" {
 
 
 ## Attributes Reference
-- `id` **String** See Argument Reference above.
-
-- `charset` **String** See Argument Reference above.
-
-- `collate` **String** See Argument Reference above.
-
-- `dbms_id` **String** See Argument Reference above.
-
-- `name` **String** See Argument Reference above.
-
+No additional attributes are exported.