diff --git a/LICENSE b/LICENSE index 39327c9..261eeb9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2018 The terraform-docs Authors. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + 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. diff --git a/README.md b/README.md index dbef2fb..fbfa84e 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,32 @@ # Cloud Vision deploy in Azure Module -This repository contains a Module for how to deploy the Cloud Vision in the Azure Cloud Platform with different components -deployment that will detect events in your infrastructure. +Terraform module that deploys the **Sysdig Secure for Cloud** stack in **Azure**. It provides unified threat detection, compliance, forensics and analysis. + +There are three major component: + +* Cloud Threat Detection: Tracks abnormal and suspicious activities in your cloud environment based on Falco language. +* CSPM/Compliance: It evaluates periodically your cloud configuration, using Cloud Custodian, against some benchmarks and returns the results and remediations you need to fix. +* Cloud Scanning: Automatically scans all container images pushed to the registry or as soon a new task which involves a container is spawned in your account. + +For other Cloud providers check: + +* [AWS](https://github.com/sysdiglabs/terraform-aws-cloudvision) +* [GCP](https://github.com/sysdiglabs/terraform-google-cloudvision) ## Usage -```hcl -module "cloud_vision_azure" { - source = "sysdiglabs/cloudvision/azure" +There are two ways to deploy this in you Azure infrastructure: + +* Using an existing resource group name (more info in the [`./examples/existing_resource_group/README.md`](examples/existing_resource_group/README.md)) +* Creating a new resource group name (more info in the [`./examples/creating_resource_group/README.md`](examples/creating_resource_group/README.md)) + + +Notice that: +- These examples will create resources that cost money. Run `terraform destroy` when you don't need them anymore +- For more detailed configuration inspect both main module and example input variables +- All created resources will be created within the tags `product:sysdig-cloudvision` - location = "centralus" - sysdig_secure_api_token = "00000000-1111-2222-3333-444444444444" -} -``` +--- ## Requirements @@ -47,11 +61,11 @@ module "cloud_vision_azure" { |------|-------------|------|---------|:--------:| | [cloudconnector\_deploy](#input\_cloudconnector\_deploy) | Whether to deploy or not CloudConnector | `bool` | `true` | no | | [location](#input\_location) | Zone where the stack will be deployed | `string` | `"centralus"` | no | -| [naming\_prefix](#input\_naming\_prefix) | Prefix for resource names. Use the default unless you need to install multiple instances, and modify the deployment at the main account accordingly | `string` | `"cloudconn"` | no | +| [naming\_prefix](#input\_naming\_prefix) | Prefix for resource names. Use the default unless you need to install multiple instances, and modify the deployment at the main account accordingly | `string` | `"cloudvision"` | no | | [resource\_group\_name](#input\_resource\_group\_name) | The resource group name to deploy cloud vision stack | `string` | `""` | no | | [sysdig\_secure\_api\_token](#input\_sysdig\_secure\_api\_token) | Sysdig's Secure API Token | `string` | n/a | yes | | [sysdig\_secure\_endpoint](#input\_sysdig\_secure\_endpoint) | Sysdig Secure API endpoint | `string` | `"https://secure.sysdig.com"` | no | -| [tags](#input\_tags) | Tags to be added to the resources | `map(string)` | 
{
  "Team": "CloudVision"
}
| no | +| [tags](#input\_tags) | Tags to be added to the resources | `map(string)` | 
{
  "product": "sysdig-cloudvision"
}
| no | ## Outputs @@ -60,7 +74,7 @@ No outputs. ## Authors -Module is maintained by [Sysdig](https://github.com/sysdiglabs/terraform-azurerm-cloudvision). +Module is maintained by [Sysdig](https://sysdig.com). ## License diff --git a/examples/creating_new_resource_group/main.tf b/examples/creating_new_resource_group/main.tf deleted file mode 100644 index 7f6b2c0..0000000 --- a/examples/creating_new_resource_group/main.tf +++ /dev/null @@ -1,13 +0,0 @@ -provider "azurerm" { - features {} - subscription_id = "[SUBSCRIPTION_ID]" -} - -module "cloudvision" { - source = "../../" - - location = "[LOCATION]" - naming_prefix = "cloudvision" - sysdig_secure_api_token = "[SYSDIG_SECURE_API_TOKEN]" - sysdig_secure_endpoint = "[SYSDIG_SECURE_ENDPOINT]" -} diff --git a/examples/creating_new_resource_group/variables.tf b/examples/creating_new_resource_group/variables.tf deleted file mode 100644 index e69de29..0000000 diff --git a/examples/existing_resource_group/README.md b/examples/existing_resource_group/README.md new file mode 100644 index 0000000..bee456a --- /dev/null +++ b/examples/existing_resource_group/README.md @@ -0,0 +1,21 @@ +# Sysdig Secure for Cloud in Azure: Existing resource group + +This module example uses a existing resource group to deploy all module resources. + +## Usage + +For quick testing, use this snippet on your terraform files + +```terraform +provider "azurerm" { + features {} + subscription_id = "00000000-1111-2222-3333-444444444444" +} + +module "cloudvision_new_resource_group" { + source = "sysdiglabs/cloudvision/azure//examples/existing_resource_group" + + sysdig_secure_api_token = "11111111-0000-3333-4444-555555222224" + resource_group_name = "your_resource_group_name" +} +``` diff --git a/examples/existing_resource_group/main.tf b/examples/existing_resource_group/main.tf index da0f1b0..b296d2b 100644 --- a/examples/existing_resource_group/main.tf +++ b/examples/existing_resource_group/main.tf @@ -1,15 +1,7 @@ -provider "azurerm" { - features {} - subscription_id = "[SUBSCRIPTION_ID]" -} - module "cloudvision" { - source = "../../" - - location = "[LOCATION]" + source = "sysdiglabs/cloudvision/azurerm" - sysdig_secure_api_token = "[SYSDIG_SECURE_API_TOKEN]" - sysdig_secure_endpoint = "[SYSDIG_SECURE_ENDPOINT]" - resource_group_name = "[RESOURCE_GROUP_NAME]" + sysdig_secure_api_token = var.sysdig_secure_api_token + resource_group_name = var.resource_group_name } diff --git a/examples/existing_resource_group/variables.tf b/examples/existing_resource_group/variables.tf index e69de29..4c712e3 100644 --- a/examples/existing_resource_group/variables.tf +++ b/examples/existing_resource_group/variables.tf @@ -0,0 +1,10 @@ +variable "sysdig_secure_api_token" { + type = string + description = "Sysdig's Secure API Token" + sensitive = true +} + +variable "resource_group_name" { + type = string + description = "The resource group name to deploy cloud vision stack" +} diff --git a/examples/new_resource_group/README.md b/examples/new_resource_group/README.md new file mode 100644 index 0000000..c2f37b0 --- /dev/null +++ b/examples/new_resource_group/README.md @@ -0,0 +1,20 @@ +# Sysdig Secure for Cloud in Azure: New resource group + +This module example creates a new resource group where deploy all module resources. + +## Usage + +For quick testing, use this snippet on your terraform files + +```terraform +provider "azurerm" { + features {} + subscription_id = "00000000-1111-2222-3333-444444444444" +} + +module "cloudvision_existing_resource_group" { + source = "sysdiglabs/cloudvision/azure//examples/new_resource_group" + + sysdig_secure_api_token = "11111111-0000-3333-4444-555555222224" +} +``` diff --git a/examples/new_resource_group/main.tf b/examples/new_resource_group/main.tf new file mode 100644 index 0000000..573cbef --- /dev/null +++ b/examples/new_resource_group/main.tf @@ -0,0 +1,6 @@ + +module "cloudvision" { + source = "sysdiglabs/cloudvision/azurerm" + + sysdig_secure_api_token = var.sysdig_secure_api_token +} diff --git a/examples/creating_new_resource_group/outputs.tf b/examples/new_resource_group/outputs.tf similarity index 100% rename from examples/creating_new_resource_group/outputs.tf rename to examples/new_resource_group/outputs.tf diff --git a/examples/new_resource_group/variables.tf b/examples/new_resource_group/variables.tf new file mode 100644 index 0000000..b9ab254 --- /dev/null +++ b/examples/new_resource_group/variables.tf @@ -0,0 +1,6 @@ + +variable "sysdig_secure_api_token" { + type = string + description = "Sysdig's Secure API Token" + sensitive = true +} diff --git a/examples/creating_new_resource_group/versions.tf b/examples/new_resource_group/versions.tf similarity index 100% rename from examples/creating_new_resource_group/versions.tf rename to examples/new_resource_group/versions.tf diff --git a/variables.tf b/variables.tf index ecb4d45..8b0675b 100644 --- a/variables.tf +++ b/variables.tf @@ -6,7 +6,7 @@ variable "naming_prefix" { condition = can(regex("^[a-zA-Z0-9\\-]+$", var.naming_prefix)) && length(var.naming_prefix) > 1 && length(var.naming_prefix) <= 64 error_message = "Must enter a naming prefix up to 64 alphanumeric characters." } - default = "cloudconn" + default = "cloudvision" } variable "cloudconnector_deploy" { @@ -37,7 +37,7 @@ variable "tags" { type = map(string) description = "Tags to be added to the resources" default = { - Team = "CloudVision" + product = "sysdig-cloudvision" } }