From 914f3d71a367d201175823f72ef336abe02f3110 Mon Sep 17 00:00:00 2001 From: Steve Worley Date: Fri, 27 Sep 2024 13:21:09 +1000 Subject: [PATCH] Add missing files. --- README.md | 68 ++++++++++++++++++++++++++++++++ SECURITY.md | 37 +++++++++++++++++ terraform-registry-manifest.json | 6 +++ 3 files changed, 111 insertions(+) create mode 100644 README.md create mode 100644 SECURITY.md create mode 100644 terraform-registry-manifest.json diff --git a/README.md b/README.md new file mode 100644 index 0000000..99ae463 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# Terraform Provider Quant + +## Quickstarts + +- [Getting started with QuantCDN and terraform](https://docs.quantcdn.io/terraform/getting-started) + +## Requirements + +- [Terraform](https://developer.hashicorp.com/terraform/downloads) >= 1.0 +- [Go](https://golang.org/doc/install) >= 1.22 + +## Building The Provider + +1. Clone the repository +1. Enter the repository directory +1. Build the provider using the Go `install` command: + +```shell +go install +``` + +## Adding Dependencies + +This provider uses [Go modules](https://github.com/golang/go/wiki/Modules). +Please see the Go documentation for the most up to date information about using Go modules. + +To add a new dependency `github.com/author/dependency` to your Terraform provider: + +```shell +go get github.com/author/dependency +go mod tidy +``` + +Then commit the changes to `go.mod` and `go.sum`. + +## Developing the Provider + +With terraform v0.14 and later, [development overrides for provider development](https://developer.hashicorp.com/terraform/cli/config/config-file#development-overrides-for-provider-developers) can be used. + +``` +provider_installation { + + # Use /home/developer/tmp/terraform-null as an overridden package directory + # for the hashicorp/null provider. This disables the version and checksum + # verifications for this provider and forces Terraform to look for the + # null provider plugin in the given directory. + dev_overrides { + "registry.terraform.io/quantcdn/quant" = "/path/to/quant-provider" + } + + # For all other providers, install them directly from their origin provider + # registries as normal. If you omit this, Terraform will _only_ use + # the dev_overrides block, and so no other providers will be available. + direct {} +} +``` + +If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#requirements) above). + +To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory. + +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. + +```shell +make testacc +``` \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..67d00c3 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,37 @@ +# Security Policy + +## Reporting a Vulnerability + +We take the security of our project seriously. If you discover a security vulnerability, please follow these steps: + +1. **Do not** disclose the vulnerability publicly until it has been addressed by our team. +2. Email us at [security@quantcdn.io](mailto:security@quantcdn.io) with details of the vulnerability. +3. Include steps to reproduce the issue, if possible. +4. We will acknowledge receipt of your report within 48 hours. + +## Security Measures + +1. **Dependency Management**: We use Dependabot to monitor and update our dependencies regularly. This helps us maintain the latest security patches. +2. **Code Review**: All changes to the codebase undergo a thorough code review process before being merged. +3. **Regular Audits**: We conduct periodic security audits of our codebase and infrastructure. + +## Vulnerability Management + +1. Once a vulnerability is reported, we will investigate and validate the issue. +2. We will work on a fix and release it as soon as possible, depending on the severity of the vulnerability. +3. We will notify users of the affected versions and provide upgrade instructions. + +## Security Best Practices + +We encourage all users and contributors to follow these security best practices: + +1. Keep your local environment and dependencies up to date. +2. Use strong, unique passwords for all accounts associated with the project. +3. Enable two-factor authentication (2FA) where available. +4. Be cautious when handling sensitive data and avoid committing secrets to the repository. + +## Contact + +For any questions or concerns regarding the security of this project, please contact us at [security@quantcdn.io](mailto:security@quantcdn.io). + +Thank you for helping us keep our project secure! \ No newline at end of file diff --git a/terraform-registry-manifest.json b/terraform-registry-manifest.json new file mode 100644 index 0000000..6e86c62 --- /dev/null +++ b/terraform-registry-manifest.json @@ -0,0 +1,6 @@ +{ + "version": 1, + "metadata": { + "protocol_versions": ["6.0"] + } +} \ No newline at end of file