Skip to content

Commit 8d9950c

Browse files
adding docs (#3)
1 parent e3956ab commit 8d9950c

25 files changed

+1329
-88
lines changed

discoveryengine/examples/exampl-main.tf

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
terraform {
22
required_providers {
33
accuknox = {
4-
source = "terraform.example.com/local/accuknox"
4+
source = "terraform.example.com/local/accuknox"
55
version = "1.0.0"
66
}
77
}
@@ -12,10 +12,10 @@ provider "accuknox" {
1212

1313
// resources
1414

15-
resource "accuknox_discovery_engine_discovered_policy" "dsp"{
16-
name="autopol-system-3960684242"
17-
namespace="wordpress-mysql"
18-
policy= <<-EOT
15+
resource "accuknox_discovery_engine_discovered_policy" "dsp" {
16+
name = "autopol-system-3960684242"
17+
namespace = "wordpress-mysql"
18+
policy = <<-EOT
1919
apiVersion: security.kubearmor.com/v1
2020
kind: KubeArmorPolicy
2121
metadata:
@@ -50,9 +50,9 @@ spec:
5050
EOT
5151
}
5252

53-
resource "accuknox_discovery_engine_enable_discovered_policy" "dsp_enable"{
54-
name="autopol-system-3960684242"
55-
namespace="wordpress-mysql"
53+
resource "accuknox_discovery_engine_enable_discovered_policy" "dsp_enable" {
54+
name = "autopol-system-3960684242"
55+
namespace = "wordpress-mysql"
5656
}
5757

5858
resource "accuknox_discovery_engine_configuration" "example_config" {
@@ -163,18 +163,18 @@ resource "accuknox_discovery_engine_configuration" "example_config" {
163163

164164
//data sources
165165

166-
data "accuknox_discovery_engine_discovered_policy" "dsp"{
167-
name="autopol-system-3960684242"
168-
namespace="wordpress-mysql"
166+
data "accuknox_discovery_engine_discovered_policy" "dsp" {
167+
name = "autopol-system-3960684242"
168+
namespace = "wordpress-mysql"
169169
}
170170

171171
output "dsp" {
172172
value = data.accuknox_discovery_engine_discovered_policy.dsp.policy
173173
}
174174

175175
data "accuknox_discovery_engine_configuration" "data_cm" {
176-
name="discovery-engine-config"
177-
namespace="accuknox-agents"
176+
name = "discovery-engine-config"
177+
namespace = "accuknox-agents"
178178
}
179179

180180
output "data_cm" {
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "accuknox_discovery_engine_configuration Data Source - terraform-provider-accuknox"
4+
subcategory: "Discovery_Engine"
5+
description: |-
6+
Provides the current discovery engine's configuration
7+
---
8+
9+
# accuknox_discovery_engine_configuration (Data Source)
10+
11+
This data source provides a mechanism to view the configuration of discovery engine.
12+
13+
## Example Usage
14+
15+
```
16+
data "accuknox_discovery_engine_configuration" "data_cm" {
17+
name="discovery-engine-config"
18+
namespace="accuknox-agents"
19+
}
20+
21+
output "data_cm" {
22+
value = data.accuknox_discovery_engine_configuration.data_cm.data
23+
}
24+
```
25+
26+
### Required
27+
28+
- `name` (Required) Name of the policy.
29+
- `namespace` (Required) Namespace of the policy.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "accuknox_discovery_engine_discovered_policy Data Source - terraform-provider-accuknox"
4+
subcategory: "Discovery_Engine"
5+
description: |-
6+
Provides the discovered policy based on name and namespace.
7+
---
8+
9+
# accuknox_discovery_engine_discovered_policy (Data Source)
10+
11+
This data source provides a mechanism to view the configuration of the discovered policy based on `name` and `namespace` provided.
12+
13+
## Example Usage
14+
15+
```
16+
data "accuknox_discovery_engine_discovered_policy" "dsp"{
17+
name="autopol-system-3960684242"
18+
namespace="wordpress-mysql"
19+
}
20+
21+
output "dsp" {
22+
value = data.accuknox_discovery_engine_discovered_policy.dsp.policy
23+
}
24+
```
25+
26+
### Argument Reference
27+
28+
- `name` (Required) Name of the policy.
29+
- `namespace` (Optional) Namespace of the policy. If not mentioned then it will be assummed as `default`.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "accuknox_kubearmor_configuration Data Source - terraform-provider-accuknox"
4+
subcategory: "kubearmor"
5+
description: |-
6+
Provides the kubearmor configuration based on name and namespace.
7+
---
8+
9+
# accuknox_kubearmor_configuration (Data Source)
10+
11+
This data source provides a mechanism to view the kubearmor configuration based on `name` and `namespace` provided.
12+
13+
## Example Usage
14+
15+
```
16+
data "accuknox_kubearmor_configuration" "data_cm" {
17+
name="kubearmor-config"
18+
namespace="kube-system"
19+
}
20+
21+
output "data_cm" {
22+
value = data.accuknox_kubearmor_configuration.data_cm.data
23+
}
24+
```
25+
### Argument Reference
26+
27+
- `name` (Required) Name of the config map which stores the data. By default it is `kubearmor-config`.
28+
- `namespace` (Optional) Namespace of the config map. By default it is `kube-system`.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "accuknox_kubearmor_host_security_policy Data Source - terraform-provider-accuknox"
4+
subcategory: "kubearmor"
5+
description: |-
6+
Provides the host security policy based on name.
7+
---
8+
9+
# accuknox_kubearmor_host_security_policy (Data Source)
10+
11+
This data source provides a mechanism to view the configuration of the host security policy based on `name` provided.
12+
13+
## Example Usage
14+
15+
```
16+
data "accuknox_kubearmor_host_security_policy" "host-policy" {
17+
name="hsp-kubearmor-dev-proc-path-block"
18+
}
19+
20+
output "host-policy" {
21+
value = data.accuknox_kubearmor_host_security_policy.host-policy.policy
22+
}
23+
```
24+
25+
### Argument Reference
26+
27+
- `name` (Required) Name of the policy.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "accuknox_kubearmor_installed_version Data Source - terraform-provider-accuknox"
4+
subcategory: "kubearmor"
5+
description: |-
6+
Provides the kubearmor installed version.
7+
---
8+
9+
# accuknox_kubearmor_installed_version (Data Source)
10+
11+
This data source provides a mechanism to view the kubearmor installed version.
12+
13+
## Example Usage
14+
15+
```
16+
data "accuknox_kubearmor_installed_version" "installed_version" {}
17+
18+
output "installed_version" {
19+
value = data.accuknox_kubearmor_installed_version.installed_version.version
20+
}
21+
```
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "accuknox_kubearmor_namespace_posture Data Source - terraform-provider-accuknox"
4+
subcategory: "kubearmor"
5+
description: |-
6+
Provides the namespace posture based on name.
7+
---
8+
9+
# accuknox_kubearmor_namespace_posture (Data Source)
10+
11+
This data source provides a mechanism to view the configuration of the namespace posture based on namespace name.
12+
13+
## Example Usage
14+
15+
```
16+
data "accuknox_kubearmor_namespace_posture" "ns_ps" {
17+
name="kube-system"
18+
}
19+
20+
output "ns_ps" {
21+
value = data.accuknox_kubearmor_namespace_posture.ns_ps.annotation
22+
}
23+
```
24+
25+
### Argument Reference
26+
27+
- `name` (Required) Namespace name.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "accuknox_kubearmor_namespace_visibility Data Source - terraform-provider-accuknox"
4+
subcategory: "kubearmor"
5+
description: |-
6+
Provides the namespace posture based on name.
7+
---
8+
9+
# accuknox_kubearmor_namespace_visibility (Data Source)
10+
11+
This data source provides a mechanism to view the configuration of the namespace visibility based on namespace name.
12+
13+
## Example Usage
14+
15+
```
16+
data "accuknox_kubearmor_namespace_visibility" "ns_vs" {
17+
name="kube-system"
18+
}
19+
20+
output "ns_vs" {
21+
value = data.accuknox_kubearmor_namespace_visibility.ns_vs.visibility
22+
}
23+
```
24+
25+
### Argument Reference
26+
27+
- `name` (Required) Namespace name.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "accuknox_kubearmor_node Data Source - terraform-provider-accuknox"
4+
subcategory: "kubearmor"
5+
description: |-
6+
Provides the kubearmor node information.
7+
---
8+
9+
# accuknox_kubearmor_node (Data Source)
10+
11+
This data source provides a mechanism to view the kubearmor node information.
12+
13+
## Example Usage
14+
15+
```
16+
data "accuknox_kubearmor_node" "k_node" {}
17+
18+
output "k_node" {
19+
value = data.accuknox_kubearmor_node.k_node.node_data
20+
}
21+
```
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "accuknox_kubearmor_security_policy Data Source - terraform-provider-accuknox"
4+
subcategory: "kubearmor"
5+
description: |-
6+
Provides the container security policy based on name and namespace.
7+
---
8+
9+
# accuknox_kubearmor_security_policy (Data Source)
10+
11+
This data source provides a mechanism to view the configuration of the container security policy based on `name` and `namespace` provided.
12+
13+
## Example Usage
14+
15+
```
16+
data "accuknox_kubearmor_security_policy" "pkg-mgmt" {
17+
name="block-pkg-mgmt-tools-exec"
18+
namespace="default"
19+
}
20+
21+
output "sp" {
22+
value = data.accuknox_kubearmor_security_policy.pkg-mgmt.policy
23+
}
24+
```
25+
### Argument Reference
26+
27+
- `name` (Required) Name of the policy.
28+
- `namespace` (Optional) Namespace of the policy. If not mentioned then it will be assummed as `default`.

0 commit comments

Comments
 (0)