Skip to content

Commit

Permalink
Merge pull request #8 from tiwood/init
Browse files Browse the repository at this point in the history
RC1
  • Loading branch information
tiwood authored May 5, 2022
2 parents c1e5c6e + 90e794b commit 734c1b2
Show file tree
Hide file tree
Showing 1,941 changed files with 563,680 additions and 273 deletions.
28 changes: 12 additions & 16 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
paths-ignore:
- 'README.md'
# For systems with an upstream API that could drift unexpectedly (like most SaaS systems, etc.),
# we recommend testing at a regular interval not necessarily tied to code changes. This will
# we recommend testing at a regular interval not necessarily tied to code changes. This will
# ensure you are alerted to something breaking due to an API change, even if the code did not
# change.
# schedule:
Expand Down Expand Up @@ -64,10 +64,6 @@ jobs:
matrix:
# list whatever Terraform versions here you would like to support
terraform:
- '0.12.*'
- '0.13.*'
- '0.14.*'
- '0.15.*'
- '1.0.*'
- '1.1.*'
steps:
Expand All @@ -89,16 +85,16 @@ jobs:
- name: Get dependencies
run: |
go mod download
- name: TF acceptance tests
timeout-minutes: 10
env:
TF_ACC: "1"
# Set whatever additional acceptance test env vars here. You can
# optionally use data from your repository secrets using the
# following syntax:
# SOME_VAR: ${{ secrets.SOME_VAR }}
# - name: TF acceptance tests
# timeout-minutes: 10
# env:
# TF_ACC: "1"

run: |
go test -v -cover ./internal/provider/
# # Set whatever additional acceptance test env vars here. You can
# # optionally use data from your repository secrets using the
# # following syntax:
# # SOME_VAR: ${{ secrets.SOME_VAR }}

# run: |
# go test -v -cover ./internal/provider/
38 changes: 15 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,23 @@
# Terraform Provider Scaffolding (Terraform Plugin SDK)

_This template repository is built on the [Terraform Plugin SDK](https://github.com/hashicorp/terraform-plugin-sdk). The template repository built on the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework) can be found at [terraform-provider-scaffolding-framework](https://github.com/hashicorp/terraform-provider-scaffolding-framework). See [Which SDK Should I Use?](https://www.terraform.io/docs/plugin/which-sdk.html) in the Terraform documentation for additional information._

This repository is a *template* for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing:

- A resource, and a data source (`internal/provider/`),
- Examples (`examples/`) and generated documentation (`docs/`),
- Miscellaneous meta files.

These files contain boilerplate code that you will need to edit to create your own Terraform provider. Tutorials for creating Terraform providers can be found on the [HashiCorp Learn](https://learn.hashicorp.com/collections/terraform/providers) platform.

Please see the [GitHub template repository documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for how to create a new repository from this template on GitHub.

Once you've written your provider, you'll want to [publish it on the Terraform Registry](https://www.terraform.io/docs/registry/providers/publishing.html) so that others can use it.
# Terraform Provider Azure Key Vault (`azurekeyvault`)

This provider is mostly a direct copy of the `Azure Key Vault` related resources
from the official `azurerm` provider. The main difference is, you dont have to
specify a `subscription_id` during provider initialization, which enables you
to create Key Vault resources in multiple Key Vaults, spanning `n` Azure subscriptions.

## Requirements

- [Terraform](https://www.terraform.io/downloads.html) >= 0.13.x
- [Terraform](https://www.terraform.io/downloads.html) >= 1.x
- [Go](https://golang.org/doc/install) >= 1.16

## Building The Provider

1. Clone the repository
1. Enter the repository directory
1. Build the provider using the Go `install` command:
2. Enter the repository directory
3. Build the provider using the Go `install` command:

```sh
$ go install
go install
```

## Adding Dependencies
Expand All @@ -36,16 +27,17 @@ Please see the Go documentation for the most up to date information about using

To add a new dependency `github.com/author/dependency` to your Terraform provider:

```
```sh
go get github.com/author/dependency
go mod tidy
```

Then commit the changes to `go.mod` and `go.sum`.

## Using the provider
## Documentation

Fill this in for each provider
Please refer to the
[Terraform provider registry](https://registry.terraform.io/providers/tiwood/azurekeyvault/latest/docs) for the documentation.

## Developing the Provider

Expand All @@ -60,5 +52,5 @@ In order to run the full suite of Acceptance tests, run `make testacc`.
*Note:* Acceptance tests create real resources, and often cost money to run.

```sh
$ make testacc
make testacc
```
32 changes: 0 additions & 32 deletions docs/data-sources/data_source.md

This file was deleted.

44 changes: 44 additions & 0 deletions docs/data-sources/secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "azurekeyvault_secret Data Source - terraform-provider-azurekeyvault"
subcategory: ""
description: |-
Use this data source to access information about an existing Key Vault Secret.
---

# azurekeyvault_secret (Data Source)

Use this data source to access information about an existing Key Vault Secret.

## Example Usage

```terraform
data "azurekeyvault_secret" "this" {
key_vault_name = "MY-KV"
name = "MY-SECRET"
}
```

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

### Required

- `key_vault_name` (String) The name of the target Key Vault.
- `name` (String) Specifies the name of the Key Vault Secret.

### Optional

- `id` (String) The ID of this resource.

### Read-Only

- `content_type` (String) Specifies the content type for the Key Vault Secret.
- `not_after` (String) Secret not usable after the provided UTC datetime `(Y-m-d'T'H:M:S'Z')`
- `not_before` (String) Secret not usable before the provided UTC datetime `(Y-m-d'T'H:M:S'Z')`
- `tags` (Map of String)
- `value` (String, Sensitive) Specifies the value of the Key Vault Secret.
- `version` (String) The current version of the Key Vault Secret.
- `versionless_id` (String) The Base ID of the Key Vault Secret.


30 changes: 22 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,36 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaffolding Provider"
subcategory: ""
layout: ""
page_title: "Provider: azurekeyvault"
description: |-
The azurekeyvault provider allows direct interaction with the Azure Key Vault data plane.
---

# scaffolding Provider

# azurekeyvault Provider

This provider is mostly a direct copy of the `Azure Key Vault` related resources
from the official `azurerm` provider. The main difference is, you dont have to
specify a `subscription_id` during provider initialization, which enables you
to create Key Vault resources in multiple Key Vaults, spanning `n` Azure subscriptions.

## Example Usage

```terraform
provider "scaffolding" {
# example configuration here
# Specifying required arguments in-file or as variables.
provider "azurekeyvault" {
tenant_id = "00000000-0000-0000-0000-000000000001"
client_id = "00000000-0000-0000-0000-000000000002"
client_secret = var.YOUR_SECRET
}
# Using environment variables
provider "azurekeyvault" {}
```

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

### Optional

- `client_id` (String) The Client ID which should be used. This can also be sourced from the `KEYVAULT_CLIENT_ID` Environment Variable.
- `client_secret` (String, Sensitive) The Client Secret which should be used. This can also be sourced from the `KEYVAULT_CLIENT_SECRET` Environment Variable.
- `tenant_id` (String) The Tenant ID should be used. This can also be sourced from the `KEYVAULT_TENANT_ID` Environment Variable.
Loading

0 comments on commit 734c1b2

Please sign in to comment.