Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sysdiglabs/terraform-provider-sysdig
Sysdig Terraform provider. Allow to handle Sysdig Secure policies as code.
https://github.com/sysdiglabs/terraform-provider-sysdig
sysdig-monitor sysdig-platform sysdig-secure terraform terraform-provider
Last synced: 7 days ago
JSON representation
Sysdig Terraform provider. Allow to handle Sysdig Secure policies as code.
- Host: GitHub
- URL: https://github.com/sysdiglabs/terraform-provider-sysdig
- Owner: sysdiglabs
- License: mpl-2.0
- Created: 2018-07-09T12:01:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T15:20:17.000Z (6 months ago)
- Last Synced: 2024-04-14T15:12:07.462Z (6 months ago)
- Topics: sysdig-monitor, sysdig-platform, sysdig-secure, terraform, terraform-provider
- Language: Go
- Homepage: https://registry.terraform.io/providers/sysdiglabs/sysdig/latest/docs
- Size: 2.44 MB
- Stars: 47
- Watchers: 40
- Forks: 48
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Terraform Provider for Sysdig
- **[Terraform Registry - Sysdig Provider Docs](https://registry.terraform.io/providers/sysdiglabs/sysdig/latest/docs)**
- [Blog on how to use this provider with Sysdig Secure](https://sysdig.com/blog/using-terraform-for-container-security-as-code/)
## Contribute
- [Requirements](#requirements)
- [Develop](#develop)
- [Compile](#compile)
- [Test](#tests)
- [Install](#install-local)
- [Proposing PR's](#proposing-prs)
- [Release](#release)
## Requirements
- [Terraform](https://www.terraform.io/downloads.html) > 0.12.x
- [Go](https://golang.org/doc/install) > Go version specified in [go.mod](./go.mod#L3)
- Correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`.
## Develop
First **clone** source repository to: `$GOPATH/src/github.com/draios/terraform-provider-sysdig`
```sh
$ git clone [email protected]:draios/terraform-provider-sysdig
$ cd terraform-provider-sysdig
$ make build
```
If you're a rookie, check [Official Terraform Provider development guides](https://developer.hashicorp.com/terraform/plugin/framework)
### Creating new resource / data sources
TL;DR;
- Create the resource/data source item
- Add the created item into the `provider.go` resource or datasource map with its wiring
- With its [acceptance **test**](#tests)
- Add its **documentation** page on `./website/docs/`
## Compile
To **compile** the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
```sh
$ make build
$ $GOPATH/bin/terraform-provider-sysdig
```
## Tests
In order to **test** the provider, you can simply run `make test` to run unit-tests.
For acceptance tests, you can run `make testacc`, but note that
- Sysdig Montir and/or Secure credentials are required, check [`/.envrc.template`](https://github.com/sysdiglabs/terraform-provider-sysdig/blob/master/.envrc.template)
- **acceptance tests rely on the creation of real infrastructure**, you should execute them in an environment where you can remove the resources easily.
If you're a rookie, check [Terraform acceptance test guidelines](https://developer.hashicorp.com/terraform/plugin/testing)
## Install (local)
To use the local provider you just built, follow the instructions to [**install** it as a plugin.](https://www.terraform.io/docs/plugins/basics.html#installing-a-plugin) in your machine with:
```sh
$ make install
```
That will add the provider to the terraform plugins dir. Then just set `source` and `version` values appropriately:
```terraform
provider "aws" {
region = my_region
}
terraform {
required_providers {
sysdig = {
source = "local/sysdiglabs/sysdig"
version = "~> 1.0.0"
}
}
}
```
To uninstall the plugin:
```sh
$ make uninstall
```
## Proposing PR's
* if it's your first time, validate you're taking into account every aspect of the [`./github/pull_request_template`](.github/pull_request_template.md)
* on pull-requests some validations are enforced.
- Defined in [`/.pre-commit-config.yaml`](https://github.com/sysdiglabs/terraform-provider-sysdig/blob/master/.pre-commit-config.yaml)
- You can work on this before even pushing to remote, using [**pre-commit**](https://pre-commit.com) plugin
* for the PR title use [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) so when the branch is squashed to main branch it follows a convention
* acceptance tests are launched in [Sysdig production `+kubelab` test environment](https://github.com/sysdiglabs/terraform-provider-sysdig/blob/master/.github/workflows/ci-pull-request.yml#L82-L83)
## Release
To create a new release, create and push a new **tag**, and it will be released following [`/.
github/workflows/release.yml`](https://github.com/sysdiglabs/terraform-provider-sysdig/blob/master/.github/workflows/release.yml).
* Before releasing check the **diff** between previous tag and master branch, to spot major changes
* For **tag**, use **[semver](https://semver.org)**
* Review Released Draft Note, and make it as clear as possible.
* Notify Sysdig teams on our internal #release-announcements slack channel and optionally in #terraform-provider
Mange takk!
