Skip to content

Commit

Permalink
Update docs for v1.6.18 release
Browse files Browse the repository at this point in the history
  • Loading branch information
pubg-devops-cicd-bot committed Apr 30, 2024
1 parent ef26de8 commit 9bcc489
Show file tree
Hide file tree
Showing 36 changed files with 3,063 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## Changelog
* 42a5655 fix
* 2d360f5 fix: publish script
74 changes: 74 additions & 0 deletions docs/data-sources/account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "bluechip_account Data Source - terraform-provider-bluechip"
subcategory: ""
description: |-
---

# bluechip_account (Data Source)



## Example Usage

```terraform
data "bluechip_account" "current" {
metadata {
name = "test2"
namespace = "default"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `metadata` (Block List) (see [below for nested schema](#nestedblock--metadata))
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.
- `spec` (List of Object) (see [below for nested schema](#nestedatt--spec))

<a id="nestedblock--metadata"></a>
### Nested Schema for `metadata`

Required:

- `name` (String) Name is the name of the resource.
- `namespace` (String) Namespace is the namespace of the resource.

Optional:

- `annotations` (Map of String) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
- `labels` (Map of String) Labels are key value pairs that may be used to scope and select individual resources. They are not queryable and should be preserved when modifying objects.

Read-Only:

- `creation_timestamp` (String) CreationTimestamp is a timestamp representing the server time when this object was created.
- `update_timestamp` (String) UpdateTimestamp is a timestamp representing the server time when this object was last updated.


<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `default` (String)


<a id="nestedatt--spec"></a>
### Nested Schema for `spec`

Read-Only:

- `account_id` (String)
- `alias` (String)
- `description` (String)
- `display_name` (String)
- `regions` (Set of String)
- `vendor` (String)
87 changes: 87 additions & 0 deletions docs/data-sources/accounts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "bluechip_accounts Data Source - terraform-provider-bluechip"
subcategory: ""
description: |-
---

# bluechip_accounts (Data Source)



## Example Usage

```terraform
data "bluechip_accounts" "current" {
namespace = "pubg"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `namespace` (String) Namespace is the namespace of the resource.

### Optional

- `filter` (Block List) Filter is a list of query terms to filter the results by. (see [below for nested schema](#nestedblock--filter))
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.
- `items` (List of Object) Filter is a list of query terms to filter the results by. (see [below for nested schema](#nestedatt--items))

<a id="nestedblock--filter"></a>
### Nested Schema for `filter`

Required:

- `field` (String) Field to use for the query term.
- `operator` (String) Operator to use for the query term. One of ['equals', 'notEquals', 'fuzzy', 'wildcard', 'regex', 'matchPhrase', 'prefix'].
- `value` (String) Value to use for the query term.


<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `default` (String)


<a id="nestedatt--items"></a>
### Nested Schema for `items`

Read-Only:

- `metadata` (List of Object) (see [below for nested schema](#nestedobjatt--items--metadata))
- `spec` (List of Object) (see [below for nested schema](#nestedobjatt--items--spec))

<a id="nestedobjatt--items--metadata"></a>
### Nested Schema for `items.metadata`

Read-Only:

- `annotations` (Map of String)
- `creation_timestamp` (String)
- `labels` (Map of String)
- `name` (String)
- `namespace` (String)
- `update_timestamp` (String)


<a id="nestedobjatt--items--spec"></a>
### Nested Schema for `items.spec`

Read-Only:

- `account_id` (String)
- `alias` (String)
- `description` (String)
- `display_name` (String)
- `regions` (Set of String)
- `vendor` (String)
70 changes: 70 additions & 0 deletions docs/data-sources/cidr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "bluechip_cidr Data Source - terraform-provider-bluechip"
subcategory: ""
description: |-
---

# bluechip_cidr (Data Source)



## Example Usage

```terraform
data "bluechip_cidr" "current" {
metadata {
name = "my-test"
namespace = "default"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `metadata` (Block List) (see [below for nested schema](#nestedblock--metadata))
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.
- `spec` (List of Object) (see [below for nested schema](#nestedatt--spec))

<a id="nestedblock--metadata"></a>
### Nested Schema for `metadata`

Required:

- `name` (String) Name is the name of the resource.
- `namespace` (String) Namespace is the namespace of the resource.

Optional:

- `annotations` (Map of String) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
- `labels` (Map of String) Labels are key value pairs that may be used to scope and select individual resources. They are not queryable and should be preserved when modifying objects.

Read-Only:

- `creation_timestamp` (String) CreationTimestamp is a timestamp representing the server time when this object was created.
- `update_timestamp` (String) UpdateTimestamp is a timestamp representing the server time when this object was last updated.


<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `default` (String)


<a id="nestedatt--spec"></a>
### Nested Schema for `spec`

Read-Only:

- `ipv4_cidrs` (Set of String)
- `ipv6_cidrs` (Set of String)
132 changes: 132 additions & 0 deletions docs/data-sources/cidrs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "bluechip_cidrs Data Source - terraform-provider-bluechip"
subcategory: ""
description: |-
---

# bluechip_cidrs (Data Source)



## Example Usage

```terraform
resource "bluechip_cidr" "c1" {
metadata {
name = "cidr1"
namespace = "default"
labels = {
"foo" = "bar"
}
annotations = {
"office" = "true"
"bluechip.example.com/location" = "seoul"
}
}
spec {
ipv4_cidrs = ["1.1.1.1/32"]
}
}
resource "bluechip_cidr" "c2" {
metadata {
name = "cidr2"
namespace = "default"
labels = {
"foo" = "bar"
}
annotations = {
"office" = "true"
"bluechip.example.com/location" = "tokyo"
}
}
spec {
ipv4_cidrs = ["1.1.1.1/32"]
}
}
data "bluechip_cidrs" "office" {
namespace = "default"
filter {
operator = "equals"
field = "metadata.annotations.office"
value = "true"
}
}
data "bluechip_cidrs" "seoul" {
namespace = "default"
filter {
operator = "equals"
field = "metadata.annotations.bluechip.example.com/location"
value = "true"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `namespace` (String) Namespace is the namespace of the resource.

### Optional

- `filter` (Block List) Filter is a list of query terms to filter the results by. (see [below for nested schema](#nestedblock--filter))
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.
- `items` (List of Object) Filter is a list of query terms to filter the results by. (see [below for nested schema](#nestedatt--items))

<a id="nestedblock--filter"></a>
### Nested Schema for `filter`

Required:

- `field` (String) Field to use for the query term.
- `operator` (String) Operator to use for the query term. One of ['equals', 'notEquals', 'fuzzy', 'wildcard', 'regex', 'matchPhrase', 'prefix'].
- `value` (String) Value to use for the query term.


<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `default` (String)


<a id="nestedatt--items"></a>
### Nested Schema for `items`

Read-Only:

- `metadata` (List of Object) (see [below for nested schema](#nestedobjatt--items--metadata))
- `spec` (List of Object) (see [below for nested schema](#nestedobjatt--items--spec))

<a id="nestedobjatt--items--metadata"></a>
### Nested Schema for `items.metadata`

Read-Only:

- `annotations` (Map of String)
- `creation_timestamp` (String)
- `labels` (Map of String)
- `name` (String)
- `namespace` (String)
- `update_timestamp` (String)


<a id="nestedobjatt--items--spec"></a>
### Nested Schema for `items.spec`

Read-Only:

- `ipv4_cidrs` (Set of String)
- `ipv6_cidrs` (Set of String)
Loading

0 comments on commit 9bcc489

Please sign in to comment.