From 1933c29369f651d4dc6b8360ba14493be3d0c701 Mon Sep 17 00:00:00 2001 From: Ravina Dhruve <136399755+ravinadhruve10@users.noreply.github.com> Date: Mon, 25 Nov 2024 08:54:50 -0800 Subject: [PATCH] Setup sysdiglabs oracle TF repo (#1) Change summary: ----------------- Initial commit setting up the repo for OCI. --- .github/git-chglog/CHANGELOG.tpl.md | 16 ++ .github/git-chglog/config.yml | 26 ++++ .github/workflows/ci-pull-request.yaml | 54 +++++++ .github/workflows/release.yaml | 45 ++++++ .gitignore | 34 +++++ CODEOWNERS | 1 + CONTRIBUTING.md | 35 +++++ LICENSE.txt | 201 +++++++++++++++++++++++++ Makefile | 30 ++++ README.md | 16 +- 10 files changed, 457 insertions(+), 1 deletion(-) create mode 100644 .github/git-chglog/CHANGELOG.tpl.md create mode 100644 .github/git-chglog/config.yml create mode 100644 .github/workflows/ci-pull-request.yaml create mode 100644 .github/workflows/release.yaml create mode 100644 .gitignore create mode 100644 CODEOWNERS create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.txt create mode 100644 Makefile diff --git a/.github/git-chglog/CHANGELOG.tpl.md b/.github/git-chglog/CHANGELOG.tpl.md new file mode 100644 index 0000000..20fc46e --- /dev/null +++ b/.github/git-chglog/CHANGELOG.tpl.md @@ -0,0 +1,16 @@ +{{ range .Versions }} {{ range .CommitGroups -}} + +{{ .Title }} +{{ range .Commits -}} + +{{ if .Scope }}{{ .Scope }}: {{ end }}{{ .Subject }} {{ if .Body }}> {{ .Body }} {{ end }} {{ end }} {{ end -}} +{{- if .RevertCommits -}} + +Reverts +{{ range .RevertCommits -}} + +{{ .Revert.Header }} {{ end }} {{ end -}} +{{- if .NoteGroups -}} {{ range .NoteGroups -}} + +{{ .Title }} +{{ range .Notes }} {{ .Body }} {{ end }} {{ end -}} {{ end -}} {{ end -}} \ No newline at end of file diff --git a/.github/git-chglog/config.yml b/.github/git-chglog/config.yml new file mode 100644 index 0000000..86f22cb --- /dev/null +++ b/.github/git-chglog/config.yml @@ -0,0 +1,26 @@ +style: github +template: CHANGELOG.tpl.md +info: + title: CHANGELOG + repository_url: https://github.com/sysdiglabs/terraform-oracle-secure +options: + commits: + commit_groups: + title_maps: + feat: Features + fix: Bug Fixes + perf: Performance Improvements + refactor: Code Refactoring + ci: Continuous Integration + docs: Documentation + chore: Small Modifications + build: Compilation & Dependencies + header: + pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$" + pattern_maps: + - Type + - Scope + - Subject + notes: + keywords: + - BREAKING CHANGE \ No newline at end of file diff --git a/.github/workflows/ci-pull-request.yaml b/.github/workflows/ci-pull-request.yaml new file mode 100644 index 0000000..882c545 --- /dev/null +++ b/.github/workflows/ci-pull-request.yaml @@ -0,0 +1,54 @@ +name: CI - Pull Request + +on: + pull_request: + branches: + - master +env: + GO_VERSION: "^1.20" + +jobs: + format: + name: Format + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - uses: hashicorp/setup-terraform@v2 + - run: make fmt + + lint: + name: Lint + runs-on: ubuntu-latest + steps: + - name: Set up Go + uses: actions/setup-go@v2 + with: + go-version: ${{ env.GO_VERSION }} + - name: Check out code + uses: actions/checkout@v2 + - name: Lint + run: make lint + + build-and-test: + name: Build and Test + runs-on: ubuntu-latest + steps: + - name: Set up Go + uses: actions/setup-go@v2 + with: + go-version: ${{ env.GO_VERSION }} + - name: Check out code + uses: actions/checkout@v2 + - name: Cache modules + uses: actions/cache@v1 + with: + path: ~/go/pkg/mod + key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} + restore-keys: | + ${{ runner.os }}-go- + - name: Get dependencies + run: | + go install github.com/onsi/ginkgo/ginkgo@latest + - name: Test + run: make test \ No newline at end of file diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..bcd1c74 --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,45 @@ +name: Release + +on: + push: + tags: + - v* + +jobs: + release: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Setup Go + uses: actions/setup-go@v2 + with: + go-version: "^1.15" + + - name: Setup go-chglog + working-directory: /tmp + env: + VERSION: "0.10.0" + run: | + wget https://github.com/git-chglog/git-chglog/releases/download/v${VERSION}/git-chglog_${VERSION}_linux_amd64.tar.gz + gunzip git-chglog_${VERSION}_linux_amd64.tar.gz + tar -xvf git-chglog_${VERSION}_linux_amd64.tar + sudo mv git-chglog /usr/local/bin/ + + - name: Generate changelog + run: git-chglog -c .github/git-chglog/config.yml -o RELEASE_CHANGELOG.md $(git describe --tags $(git rev-list --tags --max-count=1)) + + - name: Create Release + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ github.ref }} + release_name: ${{ github.ref }} + draft: true + prerelease: false + body_path: RELEASE_CHANGELOG.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..85ebeff --- /dev/null +++ b/.gitignore @@ -0,0 +1,34 @@ +# Local .terraform directories +**/.terraform/* + +# .tfstate files +*.tfstate +*.tfstate.* + +# Lock files +.terraform.lock.hcl +.terraform.tfstate.lock.info + +# Ignore override files as they are usually used for local settings +override.tf +override.tf.json +*_override.tf +*_override.tf.json + +# Ignore CLI configuration files +.terraformrc +terraform.rc + +# Ignore backup files +terraform.tfstate.backup + +# Ignore crash log files +crash.log + +# Ignore all .tfvars files, which are likely to contain sentitive data +*.tfvars + +.envrc +.direnv +.DS_Store +.idea/ \ No newline at end of file diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..c881560 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @sysdiglabs/team-secure-onboarding \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3ce6a92 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing + +## Scopes + +When you need to use a scope in a commit message, use the directories under `pkg` as a reference +to specify the scope. Some suggestions: + +- aws +- gcp +- azure +- oracle +- ... + +## When opening a new PR + +- The following **requirements** are checked in a PR: + - make build + - make test-unit + - make test-integration # These requires a real environment (`draios-demo`) and are slower than the others. + - make test-e2e + - make test-rules + - make lint + + + +## Testing + +It's recommended to use an .envrc file to keep environment variables under control. Check `.envrc.template` for a reference. + +## Release + +- push a new tag and the Github Action will draft a release (with notes) \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..3e64988 --- /dev/null +++ b/Makefile @@ -0,0 +1,30 @@ +PROJECT := terraform-oracle-secure +GO_BIN := $(shell go env GOPATH)/bin +TFLINT := $(GO_BIN)/tflint +DOCKER ?= docker + +SHELL := /bin/bash + +$(TFLINT): export TMPDIR = $(shell mktemp -d) +$(TFLINT): + curl -sL https://github.com/terraform-linters/tflint/releases/latest/download/tflint_$(shell go env GOHOSTOS)_$(shell go env GOHOSTARCH).zip -o $${TMPDIR}/tflint.zip + unzip $${TMPDIR}/tflint.zip -d $(GO_BIN) tflint + rm -rf $${TMPDIR} + +deps: $(TFLINT) + go install github.com/terraform-docs/terraform-docs@v0.16.0 + go install github.com/hashicorp/terraform-config-inspect@latest + +lint: $(TFLINT) + $(MAKE) -C modules lint + +fmt: + terraform fmt -check -recursive modules + +clean: + find -name ".terraform" -type d | xargs rm -rf + find -name ".terraform.lock.hcl" -type f | xargs rm -f + +.PHONY: test +test: + $(MAKE) -C test test \ No newline at end of file diff --git a/README.md b/README.md index a75dd2d..30d99a2 100644 --- a/README.md +++ b/README.md @@ -1 +1,15 @@ -# terraform-oracle-secure +# Sysdig Secure for Cloud in Oracle + +Terraform module that deploys the Sysdig Secure for Cloud stack in Oracle. +
+ +For other Cloud providers check: [AWS](https://github.com/sysdiglabs/terraform-aws-secure) , [GCP](https://github.com/sysdiglabs/terraform-google-secure), [Azure](https://github.com/sysdiglabs/terraform-azurerm-secure) +
+ +## Authors + +Module is maintained and supported by [Sysdig](https://sysdig.com). + +## License + +Apache 2 Licensed. See LICENSE for full details.