Skip to content

Commit

Permalink
Generate libsonnet source from libgenerator PR tf-libsonnet/libgenera…
Browse files Browse the repository at this point in the history
…tor#189

Signed-off-by: tflibsonnet-ci <[email protected]>
  • Loading branch information
renovate[bot] authored and tflibsonnet-ci committed Jul 13, 2023
1 parent 69d46c6 commit 51355ff
Show file tree
Hide file tree
Showing 6 changed files with 271 additions and 2 deletions.
1 change: 1 addition & 0 deletions 3.x/_gen/main.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet');
password_policy: (import 'resources/password_policy.libsonnet'),
pki_secret_backend_cert: (import 'resources/pki_secret_backend_cert.libsonnet'),
pki_secret_backend_config_ca: (import 'resources/pki_secret_backend_config_ca.libsonnet'),
pki_secret_backend_config_issuers: (import 'resources/pki_secret_backend_config_issuers.libsonnet'),
pki_secret_backend_config_urls: (import 'resources/pki_secret_backend_config_urls.libsonnet'),
pki_secret_backend_crl_config: (import 'resources/pki_secret_backend_crl_config.libsonnet'),
pki_secret_backend_intermediate_cert_request: (import 'resources/pki_secret_backend_intermediate_cert_request.libsonnet'),
Expand Down
18 changes: 16 additions & 2 deletions 3.x/_gen/provider_vault.libsonnet

Large diffs are not rendered by default.

76 changes: 76 additions & 0 deletions 3.x/_gen/resources/pki_secret_backend_config_issuers.libsonnet
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet');
local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet');
{
'#':: d.pkg(name='pki_secret_backend_config_issuers', url='', help='`pki_secret_backend_config_issuers` represents the `vault_pki_secret_backend_config_issuers` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'),
'#new':: d.fn(help="\n`vault.pki_secret_backend_config_issuers.new` injects a new `vault_pki_secret_backend_config_issuers` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n vault.pki_secret_backend_config_issuers.new('some_id')\n\nYou can get the reference to the `id` field of the created `vault.pki_secret_backend_config_issuers` using the reference:\n\n $._ref.vault_pki_secret_backend_config_issuers.some_id.get('id')\n\nThis is the same as directly entering `\"${ vault_pki_secret_backend_config_issuers.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `backend` (`string`): Full path where PKI backend is mounted.\n - `default` (`string`): Specifies the default issuer by ID. When `null`, the `default` field will be omitted from the resulting object.\n - `default_follows_latest_issuer` (`bool`): Specifies whether a root creation or an issuer import operation updates the default issuer to the newly added issuer. When `null`, the `default_follows_latest_issuer` field will be omitted from the resulting object.\n - `namespace` (`string`): Target namespace. (requires Enterprise) When `null`, the `namespace` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]),
new(
resourceLabel,
backend,
default=null,
default_follows_latest_issuer=null,
namespace=null,
_meta={}
):: tf.withResource(
type='vault_pki_secret_backend_config_issuers',
label=resourceLabel,
attrs=self.newAttrs(
backend=backend,
default=default,
default_follows_latest_issuer=default_follows_latest_issuer,
namespace=namespace
),
_meta=_meta
),
'#newAttrs':: d.fn(help='\n`vault.pki_secret_backend_config_issuers.newAttrs` constructs a new object with attributes and blocks configured for the `pki_secret_backend_config_issuers`\nTerraform resource.\n\nUnlike [vault.pki_secret_backend_config_issuers.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `backend` (`string`): Full path where PKI backend is mounted.\n - `default` (`string`): Specifies the default issuer by ID. When `null`, the `default` field will be omitted from the resulting object.\n - `default_follows_latest_issuer` (`bool`): Specifies whether a root creation or an issuer import operation updates the default issuer to the newly added issuer. When `null`, the `default_follows_latest_issuer` field will be omitted from the resulting object.\n - `namespace` (`string`): Target namespace. (requires Enterprise) When `null`, the `namespace` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `pki_secret_backend_config_issuers` resource into the root Terraform configuration.\n', args=[]),
newAttrs(
backend,
default=null,
default_follows_latest_issuer=null,
namespace=null
):: std.prune(a={
backend: backend,
default: default,
default_follows_latest_issuer: default_follows_latest_issuer,
namespace: namespace,
}),
'#withBackend':: d.fn(help='`vault.string.withBackend` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the backend field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `backend` field.\n', args=[]),
withBackend(resourceLabel, value): {
resource+: {
vault_pki_secret_backend_config_issuers+: {
[resourceLabel]+: {
backend: value,
},
},
},
},
'#withDefault':: d.fn(help='`vault.string.withDefault` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the default field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `default` field.\n', args=[]),
withDefault(resourceLabel, value): {
resource+: {
vault_pki_secret_backend_config_issuers+: {
[resourceLabel]+: {
default: value,
},
},
},
},
'#withDefaultFollowsLatestIssuer':: d.fn(help='`vault.bool.withDefaultFollowsLatestIssuer` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the default_follows_latest_issuer field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `default_follows_latest_issuer` field.\n', args=[]),
withDefaultFollowsLatestIssuer(resourceLabel, value): {
resource+: {
vault_pki_secret_backend_config_issuers+: {
[resourceLabel]+: {
default_follows_latest_issuer: value,
},
},
},
},
'#withNamespace':: d.fn(help='`vault.string.withNamespace` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the namespace field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `namespace` field.\n', args=[]),
withNamespace(resourceLabel, value): {
resource+: {
vault_pki_secret_backend_config_issuers+: {
[resourceLabel]+: {
namespace: value,
},
},
},
},
}
1 change: 1 addition & 0 deletions docs/3.x/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ project.
* [password_policy](password_policy.md)
* [pki_secret_backend_cert](pki_secret_backend_cert.md)
* [pki_secret_backend_config_ca](pki_secret_backend_config_ca.md)
* [pki_secret_backend_config_issuers](pki_secret_backend_config_issuers.md)
* [pki_secret_backend_config_urls](pki_secret_backend_config_urls.md)
* [pki_secret_backend_crl_config](pki_secret_backend_crl_config.md)
* [pki_secret_backend_intermediate_cert_request](pki_secret_backend_intermediate_cert_request.md)
Expand Down
149 changes: 149 additions & 0 deletions docs/3.x/pki_secret_backend_config_issuers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
---
permalink: /pki_secret_backend_config_issuers/
---

# pki_secret_backend_config_issuers

`pki_secret_backend_config_issuers` represents the `vault_pki_secret_backend_config_issuers` Terraform resource.



This package contains functions and utilities for setting up the resource using Jsonnet code.


## Index

* [`fn new()`](#fn-new)
* [`fn newAttrs()`](#fn-newattrs)
* [`fn withBackend()`](#fn-withbackend)
* [`fn withDefault()`](#fn-withdefault)
* [`fn withDefaultFollowsLatestIssuer()`](#fn-withdefaultfollowslatestissuer)
* [`fn withNamespace()`](#fn-withnamespace)

## Fields

### fn new

```ts
new()
```


`vault.pki_secret_backend_config_issuers.new` injects a new `vault_pki_secret_backend_config_issuers` Terraform `resource`
block into the root module document.

Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the
resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
vault.pki_secret_backend_config_issuers.new('some_id')

You can get the reference to the `id` field of the created `vault.pki_secret_backend_config_issuers` using the reference:

$._ref.vault_pki_secret_backend_config_issuers.some_id.get('id')

This is the same as directly entering `"${ vault_pki_secret_backend_config_issuers.some_id.id }"` as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,
or `$` to refer to the root object. Instead, make an explicit outer object using `local`.

**Args**:
- `resourceLabel` (`string`): The name label of the block.
- `backend` (`string`): Full path where PKI backend is mounted.
- `default` (`string`): Specifies the default issuer by ID. When `null`, the `default` field will be omitted from the resulting object.
- `default_follows_latest_issuer` (`bool`): Specifies whether a root creation or an issuer import operation updates the default issuer to the newly added issuer. When `null`, the `default_follows_latest_issuer` field will be omitted from the resulting object.
- `namespace` (`string`): Target namespace. (requires Enterprise) When `null`, the `namespace` field will be omitted from the resulting object.

**Returns**:
- A mixin object that injects the new resource into the root Terraform configuration.


### fn newAttrs

```ts
newAttrs()
```


`vault.pki_secret_backend_config_issuers.newAttrs` constructs a new object with attributes and blocks configured for the `pki_secret_backend_config_issuers`
Terraform resource.

Unlike [vault.pki_secret_backend_config_issuers.new](#fn-new), this function will not inject the `resource`
block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the
[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to
injecting into a complete block.

**Args**:
- `backend` (`string`): Full path where PKI backend is mounted.
- `default` (`string`): Specifies the default issuer by ID. When `null`, the `default` field will be omitted from the resulting object.
- `default_follows_latest_issuer` (`bool`): Specifies whether a root creation or an issuer import operation updates the default issuer to the newly added issuer. When `null`, the `default_follows_latest_issuer` field will be omitted from the resulting object.
- `namespace` (`string`): Target namespace. (requires Enterprise) When `null`, the `namespace` field will be omitted from the resulting object.

**Returns**:
- An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `pki_secret_backend_config_issuers` resource into the root Terraform configuration.


### fn withBackend

```ts
withBackend()
```

`vault.string.withBackend` constructs a mixin object that can be merged into the `string`
Terraform resource block to set or update the backend field.



**Args**:
- `resourceLabel` (`string`): The name label of the block to update.
- `value` (`string`): The value to set for the `backend` field.


### fn withDefault

```ts
withDefault()
```

`vault.string.withDefault` constructs a mixin object that can be merged into the `string`
Terraform resource block to set or update the default field.



**Args**:
- `resourceLabel` (`string`): The name label of the block to update.
- `value` (`string`): The value to set for the `default` field.


### fn withDefaultFollowsLatestIssuer

```ts
withDefaultFollowsLatestIssuer()
```

`vault.bool.withDefaultFollowsLatestIssuer` constructs a mixin object that can be merged into the `bool`
Terraform resource block to set or update the default_follows_latest_issuer field.



**Args**:
- `resourceLabel` (`string`): The name label of the block to update.
- `value` (`bool`): The value to set for the `default_follows_latest_issuer` field.


### fn withNamespace

```ts
withNamespace()
```

`vault.string.withNamespace` constructs a mixin object that can be merged into the `string`
Terraform resource block to set or update the namespace field.



**Args**:
- `resourceLabel` (`string`): The name label of the block to update.
- `value` (`string`): The value to set for the `namespace` field.
28 changes: 28 additions & 0 deletions docs/3.x/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ This package contains functions and utilities for setting up the provider using
* [`fn new()`](#fn-auth_login_oidcnew)
* [`obj auth_login_radius`](#obj-auth_login_radius)
* [`fn new()`](#fn-auth_login_radiusnew)
* [`obj auth_login_token_file`](#obj-auth_login_token_file)
* [`fn new()`](#fn-auth_login_token_filenew)
* [`obj auth_login_userpass`](#obj-auth_login_userpass)
* [`fn new()`](#fn-auth_login_userpassnew)
* [`obj client_auth`](#obj-client_auth)
Expand Down Expand Up @@ -84,6 +86,7 @@ the `src` and/or `version` parameters are set.
- `auth_login_oci` (`list[obj]`): Login to vault using the OCI method When `null`, the `auth_login_oci` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.auth_login_oci.new](#fn-vaultauthloginocinew) constructor.
- `auth_login_oidc` (`list[obj]`): Login to vault using the oidc method When `null`, the `auth_login_oidc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.auth_login_oidc.new](#fn-vaultauthloginoidcnew) constructor.
- `auth_login_radius` (`list[obj]`): Login to vault using the radius method When `null`, the `auth_login_radius` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.auth_login_radius.new](#fn-vaultauthloginradiusnew) constructor.
- `auth_login_token_file` (`list[obj]`): Login to vault using When `null`, the `auth_login_token_file` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.auth_login_token_file.new](#fn-vaultauthlogintokenfilenew) constructor.
- `auth_login_userpass` (`list[obj]`): Login to vault using the userpass method When `null`, the `auth_login_userpass` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.auth_login_userpass.new](#fn-vaultauthloginuserpassnew) constructor.
- `client_auth` (`list[obj]`): Client authentication credentials. When `null`, the `client_auth` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.client_auth.new](#fn-vaultclientauthnew) constructor.
- `headers` (`list[obj]`): The headers to send with each Vault request. When `null`, the `headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.headers.new](#fn-vaultheadersnew) constructor.
Expand Down Expand Up @@ -143,6 +146,7 @@ injecting into a complete block.
- `auth_login_oci` (`list[obj]`): Login to vault using the OCI method When `null`, the `auth_login_oci` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.auth_login_oci.new](#fn-vaultauthloginocinew) constructor.
- `auth_login_oidc` (`list[obj]`): Login to vault using the oidc method When `null`, the `auth_login_oidc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.auth_login_oidc.new](#fn-vaultauthloginoidcnew) constructor.
- `auth_login_radius` (`list[obj]`): Login to vault using the radius method When `null`, the `auth_login_radius` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.auth_login_radius.new](#fn-vaultauthloginradiusnew) constructor.
- `auth_login_token_file` (`list[obj]`): Login to vault using When `null`, the `auth_login_token_file` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.auth_login_token_file.new](#fn-vaultauthlogintokenfilenew) constructor.
- `auth_login_userpass` (`list[obj]`): Login to vault using the userpass method When `null`, the `auth_login_userpass` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.auth_login_userpass.new](#fn-vaultauthloginuserpassnew) constructor.
- `client_auth` (`list[obj]`): Client authentication credentials. When `null`, the `client_auth` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.client_auth.new](#fn-vaultclientauthnew) constructor.
- `headers` (`list[obj]`): The headers to send with each Vault request. When `null`, the `headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [vault.provider.headers.new](#fn-vaultheadersnew) constructor.
Expand Down Expand Up @@ -440,6 +444,30 @@ Terraform sub block.
- An attribute object that represents the `auth_login_radius` sub block.


## obj auth_login_token_file



### fn auth_login_token_file.new

```ts
new()
```


`vault.auth_login_token_file.new` constructs a new object with attributes and blocks configured for the `auth_login_token_file`
Terraform sub block.



**Args**:
- `filename` (`string`): The name of a file containing a single line that is a valid Vault token
- `namespace` (`string`): The authentication engine&#39;s namespace. When `null`, the `namespace` field will be omitted from the resulting object.

**Returns**:
- An attribute object that represents the `auth_login_token_file` sub block.


## obj auth_login_userpass


Expand Down

0 comments on commit 51355ff

Please sign in to comment.