docs: add doc for sysdig_secure_vulnerability_accept_risk

Author: tembleking

.gitignore

@@ -57,3 +57,6 @@ dist/
 
 # Nix result
 result
+
+main.tf
+terraform-providers-schema/

GNUmakefile

@@ -71,6 +71,30 @@ lint:
 errcheck:
 	@sh -c "'$(CURDIR)/scripts/errcheck.sh'"
 
+# Leverages on nix compiling and configuring the provider using the package.nix and the devshell
+init-provider-to-test:
+	echo 'terraform { ' > main.tf
+	echo 'required_providers { sysdig = { ' >> main.tf
+	echo 'source = "sysdiglabs/sysdig" ' >> main.tf
+	echo 'version = "1.0.0-local" ' >> main.tf
+	echo '} }' >> main.tf
+	echo '}' >> main.tf
+	terraform init
+
+.PHONY: terraform-providers-schema
+terraform-providers-schema:
+	rm -rf terraform-providers-schema
+	mkdir -p terraform-providers-schema
+
+doccheck: terraform-providers-schema init-provider-to-test
+	terraform providers schema -json > terraform-providers-schema/schema.json
+	tfproviderdocs check \
+          -allowed-resource-subcategories-file website/allowed-subcategories.txt \
+          -enable-contents-check \
+          -provider-source registry.terraform.io/sysdiglabs/sysdig \
+          -providers-schema-json terraform-providers-schema/schema.json \
+          -require-resource-subcategory
+
 test-compile:
 	@if [ "$(TEST)" = "./..." ]; then \
 		echo "ERROR: Set TEST to a specific package. For example,"; \

flake.lock

@@ -2,26 +2,39 @@
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
     flake-utils.url = "github:numtide/flake-utils";
+    tfproviderdocs-init.url = "github:nixos/nixpkgs/pull/366576/head"; # tfproviderdocs is not yet a package in nixpkgs, so this workaronuds it
   };
   outputs =
     {
       self,
       nixpkgs,
       flake-utils,
+      tfproviderdocs-init,
     }:
     let
       overlays.default = final: prev: {
         terraform-providers = prev.terraform-providers // {
           sysdig = prev.callPackage ./package.nix { };
         };
       };
+      overlays.tfproviderdocs =
+        final: prev:
+        let
+          pkgs = import tfproviderdocs-init { inherit (prev) system; };
+        in
+        {
+          inherit (pkgs) tfproviderdocs;
+        };
       flake = flake-utils.lib.eachDefaultSystem (
         system:
         let
           pkgs = import nixpkgs {
             inherit system;
             config.allowUnfree = true;
-            overlays = [ self.overlays.default ];
+            overlays = [
+              self.overlays.default
+              self.overlays.tfproviderdocs
+            ];
           };
         in
         {
@@ -45,6 +58,8 @@
                 govulncheck
                 golangci-lint
                 golangci-lint-langserver
+                (terraform.withPlugins (tf: [ tf.sysdig ]))
+                tfproviderdocs
               ];
             };
 

flake.nix

@@ -15,7 +15,7 @@ terraform-providers.mkProvider {
   repo = "terraform-provider-sysdig";
   homepage = "https://registry.terraform.io/providers/sysdiglabs/sysdig";
   rev = "1.0.0-local"; # Keeping this version fixed with a `-local` version, so user can just bundle the concrete plugin version with terraform using nix.
-  vendorHash = "sha256-9ru4RkH2fDWcgM0I3URlWd811PwySktd+gLsEr624WM=";
+  vendorHash = "sha256-eZl/UKvLG1Yi59oRl70CvrAIyLoyPW0ILWmFMzdUdDQ=";
   hash = "";
   mkProviderFetcher = { ... }: ./.;
 }