diff --git a/.github/workflows/dsf_poc_cli.yml b/.github/workflows/dsf_poc_cli.yml index 197e8bbff..3737996bc 100644 --- a/.github/workflows/dsf_poc_cli.yml +++ b/.github/workflows/dsf_poc_cli.yml @@ -64,7 +64,7 @@ jobs: name: '${{ matrix.name }}' runs-on: ubuntu-latest env: - EXAMPLE_DIR: ./examples/poc/dsf_deployment + EXAMPLE_DIR: ./examples/aws/poc/dsf_deployment AWS_REGION: eu-west-2 TF_VAR_enable_sonar: ${{ matrix.enable_sonar }} TF_VAR_enable_dam: ${{ matrix.enable_dam }} diff --git a/.github/workflows/dsf_poc_cli_azure.yml b/.github/workflows/dsf_poc_cli_azure.yml index 50ae2b1b1..ee202c095 100644 --- a/.github/workflows/dsf_poc_cli_azure.yml +++ b/.github/workflows/dsf_poc_cli_azure.yml @@ -49,7 +49,7 @@ jobs: name: '${{ matrix.name }}' runs-on: ubuntu-latest env: - EXAMPLE_DIR: ./examples/azure/dsf_deployment + EXAMPLE_DIR: ./examples/azure/poc/dsf_deployment environment: test # Use the Bash shell regardless whether the GitHub Actions runner is ubuntu-latest, macos-latest, or windows-latest diff --git a/.github/workflows/dsf_single_account_cli.yml b/.github/workflows/dsf_single_account_cli.yml index f092fa40c..5cc60bacf 100644 --- a/.github/workflows/dsf_single_account_cli.yml +++ b/.github/workflows/dsf_single_account_cli.yml @@ -35,7 +35,7 @@ env: TF_CLI_ARGS: "-no-color" TF_INPUT: 0 TF_VAR_gw_count: 1 - EXAMPLE_DIR: ./examples/installation/dsf_single_account_deployment + EXAMPLE_DIR: ./examples/aws/installation/dsf_single_account_deployment AWS_REGION: ap-southeast-1 AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} diff --git a/.github/workflows/nightly_sonar_poc_basic_cli.yml b/.github/workflows/nightly_sonar_poc_basic_cli.yml index 67a1bb7ae..81cafee20 100644 --- a/.github/workflows/nightly_sonar_poc_basic_cli.yml +++ b/.github/workflows/nightly_sonar_poc_basic_cli.yml @@ -35,7 +35,7 @@ env: TF_CLI_ARGS: "-no-color" TF_INPUT: 0 TF_VAR_gw_count: 2 - EXAMPLE_DIR: ./examples/poc/sonar_basic_deployment + EXAMPLE_DIR: ./examples/aws/poc/sonar_basic_deployment AWS_REGION: eu-west-2 AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} diff --git a/.github/workflows/plan_cli.yml b/.github/workflows/plan_cli.yml index 9e94ddeee..b1f14c7f3 100644 --- a/.github/workflows/plan_cli.yml +++ b/.github/workflows/plan_cli.yml @@ -37,7 +37,7 @@ on: paths-ignore: - '.github/**' - 'modules/aws/sonar-upgrader/**' - - 'examples/sonar_upgrade/*' + - 'examples/aws/sonar_upgrade/*' - 'installer_machine/*' - 'dsf_instances_permissions_samples/*' - 'permissions_samples/*' @@ -62,7 +62,7 @@ jobs: matrix: include: - name: Azure - POC - DSF - example: ./examples/azure/dsf_deployment + example: ./examples/azure/poc/dsf_deployment terraformvars: | resource_group_location = "East US" tarball_location = { @@ -72,19 +72,19 @@ jobs: az_blob = "dummy-blob" } - name: AWS - POC - DSF - example: ./examples/poc/dsf_deployment + example: ./examples/aws/poc/dsf_deployment terraformvars: | dam_license="license.mprv" - name: AWS - POC - Sonar Basic - example: ./examples/poc/sonar_basic_deployment + example: ./examples/aws/poc/sonar_basic_deployment - name: AWS - POC - Sonar HADR - example: ./examples/poc/sonar_hadr_deployment + example: ./examples/aws/poc/sonar_hadr_deployment - name: AWS - Installation - Sonar Single Account - example: ./examples/installation/sonar_single_account_deployment + example: ./examples/aws/installation/sonar_single_account_deployment - name: AWS - Installation - Sonar Multi Account - example: ./examples/installation/sonar_multi_account_deployment + example: ./examples/aws/installation/sonar_multi_account_deployment - name: AWS - Installation - DSF Single Account - example: ./examples/installation/dsf_single_account_deployment + example: ./examples/aws/installation/dsf_single_account_deployment name: '${{ matrix.name }}' env: diff --git a/.github/workflows/run_test.yml b/.github/workflows/run_test.yml index 0ca775a83..2cde9ea84 100644 --- a/.github/workflows/run_test.yml +++ b/.github/workflows/run_test.yml @@ -31,7 +31,7 @@ on: - 'dev' paths: - 'modules/aws/sonar-upgrader/*' - - 'examples/sonar_upgrade/*' + - 'examples/aws/sonar_upgrade/*' env: TF_CLI_ARGS: "-no-color" @@ -61,8 +61,8 @@ jobs: name: '${{ matrix.name }}' runs-on: ubuntu-latest env: - DEPLOYMENT_EXAMPLE_DIR: ./examples/poc/dsf_deployment - UPGRADE_EXAMPLE_DIR: ./examples/sonar_upgrade + DEPLOYMENT_EXAMPLE_DIR: ./examples/aws/poc/dsf_deployment + UPGRADE_EXAMPLE_DIR: ./examples/aws/sonar_upgrade AWS_REGION: eu-west-2 SONAR_TARGET_VERSION: 4.13.0.10.0 TF_VAR_enable_sonar: ${{ matrix.enable_sonar }} diff --git a/.github/workflows/sonar_multi_account_cli.yml b/.github/workflows/sonar_multi_account_cli.yml index 3126b8d10..a73478628 100644 --- a/.github/workflows/sonar_multi_account_cli.yml +++ b/.github/workflows/sonar_multi_account_cli.yml @@ -33,7 +33,7 @@ env: TF_CLI_ARGS: "-no-color" TF_INPUT: 0 TF_VAR_gw_count: 1 - EXAMPLE_DIR: ./examples/installation/sonar_multi_account_deployment + EXAMPLE_DIR: ./examples/aws/installation/sonar_multi_account_deployment AWS_REGION: ap-southeast-1 AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} diff --git a/.github/workflows/sonar_poc_cli.yml b/.github/workflows/sonar_poc_cli.yml index dad830742..c342916e7 100644 --- a/.github/workflows/sonar_poc_cli.yml +++ b/.github/workflows/sonar_poc_cli.yml @@ -37,8 +37,8 @@ on: - 'modules/aws/rds-mysql-db/*' - 'modules/null/federation/*' - 'modules/null/hadr/*' - - 'examples/poc/sonar_basic_deployment/*' - - 'examples/poc/sonar_hadr_deployment/*' + - 'examples/aws/poc/sonar_basic_deployment/*' + - 'examples/aws/poc/sonar_hadr_deployment/*' pull_request: types: @@ -57,8 +57,8 @@ on: - 'modules/aws/rds-mysql-db/*' - 'modules/null/federation/*' - 'modules/null/hadr/*' - - 'examples/poc/sonar_basic_deployment/*' - - 'examples/poc/sonar_hadr_deployment/*' + - 'examples/aws/poc/sonar_basic_deployment/*' + - 'examples/aws/poc/sonar_hadr_deployment/*' env: TF_CLI_ARGS: "-no-color" @@ -77,12 +77,12 @@ jobs: matrix: include: - workspace: basic_cli-${{ github.run_number }}-${{ github.run_attempt }} - example_dir: ./examples/poc/sonar_basic_deployment + example_dir: ./examples/aws/poc/sonar_basic_deployment aws_region: eu-west-2 hub_output: '.dsf_hub.value.public_dns' gw_output: '.dsf_agentless_gw.value."agentless-gw-0".private_ip' - workspace: hadr_cli-${{ github.run_number }}-${{ github.run_attempt }} - example_dir: ./examples/poc/sonar_hadr_deployment + example_dir: ./examples/aws/poc/sonar_hadr_deployment aws_region: eu-west-1 hub_output: '.dsf_hubs.value.main.public_dns' gw_output: '.dsf_agentless_gw.value."agentless-gw-0".main.private_ip' diff --git a/.github/workflows/sonar_single_account_cli.yml b/.github/workflows/sonar_single_account_cli.yml index 1cfb18ba7..5a2527514 100644 --- a/.github/workflows/sonar_single_account_cli.yml +++ b/.github/workflows/sonar_single_account_cli.yml @@ -46,7 +46,7 @@ jobs: matrix: include: - name: single account - example_dir: examples/installation/sonar_single_account_deployment + example_dir: examples/aws/installation/sonar_single_account_deployment target_dir: single_account name: '${{ matrix.name }} ${{ inputs.branch }}' diff --git a/.github/workflows/sonar_upgrade.yml b/.github/workflows/sonar_upgrade.yml index 677197010..a8fbd1196 100644 --- a/.github/workflows/sonar_upgrade.yml +++ b/.github/workflows/sonar_upgrade.yml @@ -53,8 +53,8 @@ jobs: name: '${{ matrix.name }}' runs-on: ubuntu-latest env: - DEPLOYMENT_EXAMPLE_DIR: ./examples/poc/dsf_deployment - UPGRADE_EXAMPLE_DIR: ./examples/sonar_upgrade + DEPLOYMENT_EXAMPLE_DIR: ./examples/aws/poc/dsf_deployment + UPGRADE_EXAMPLE_DIR: ./examples/aws/sonar_upgrade AWS_REGION: eu-west-2 SONAR_TARGET_VERSION: 4.13.0.10.0 TF_VAR_enable_sonar: ${{ matrix.enable_sonar }} diff --git a/.github/workflows/sonar_upgrade_flow.yml b/.github/workflows/sonar_upgrade_flow.yml index c39022336..4b1c7e737 100644 --- a/.github/workflows/sonar_upgrade_flow.yml +++ b/.github/workflows/sonar_upgrade_flow.yml @@ -19,7 +19,7 @@ on: - 'dev' paths: - 'modules/aws/sonar-upgrader/**' - - 'examples/sonar_upgrade/*' + - 'examples/aws/sonar_upgrade/*' pull_request: types: @@ -30,7 +30,7 @@ on: - 'dev' paths: - 'modules/aws/sonar-upgrader/**' - - 'examples/sonar_upgrade/*' + - 'examples/aws/sonar_upgrade/*' permissions: contents: read diff --git a/README.md b/README.md index 03a999293..b6975715c 100644 --- a/README.md +++ b/README.md @@ -484,73 +484,73 @@ For more details about each example, click on the example name. - Sonar Basic Deployment + Sonar Basic Deployment Lab/POC A DSF deployment with a DSF Hub, an Agentless Gateway, federation, networking and onboarding of a MySQL DB. - sonar_basic_deployment_1_5_7.zip + sonar_basic_deployment_1_5_7.zip - Sonar HADR Deployment + Sonar HADR Deployment Lab/POC A DSF deployment with a DSF Hub, an Agentless Gateway, DSF Hub and Agentless Gateway HADR, federation, networking and onboarding of a MySQL DB. - sonar_hadr_deployment_1_5_7.zip + sonar_hadr_deployment_1_5_7.zip - Sonar Single Account Deployment + Sonar Single Account Deployment PS/Customer A DSF deployment with a DSF Hub HADR, an Agentless Gateway and federation. The DSF nodes (Hubs and Agentless Gateway) are in the same AWS account and the same region. It is mandatory to provide as input to this example the subnets to deploy the DSF nodes on. - sonar_single_account_deployment_1_5_7.zip + sonar_single_account_deployment_1_5_7.zip - Sonar Multi Account Deployment + Sonar Multi Account Deployment PS/Customer A DSF deployment with a DSF Hub, an Agentless Gateway and federation. The DSF nodes (Hub and Agentless Gateway) are in different AWS accounts. It is mandatory to provide as input to this example the subnets to deploy the DSF nodes on. - sonar_multi_account_deployment_1_5_7.zip + sonar_multi_account_deployment_1_5_7.zip - DSF Deployment + DSF Deployment Lab/POC A full DSF deployment with DSF Hub and Agentless Gateways (formerly Sonar), DAM (MX and Agent Gateways), DRA (Admin and DRA Analytics), and Agent and Agentless audit sources. - dsf_deployment_1_5_7.zip + dsf_deployment_1_5_7.zip - DSF Single Account Deployment + DSF Single Account Deployment PS/Customer A full DSF deployment with DSF Hub and Agentless Gateways (formerly Sonar), DAM (MX and Agent Gateways) and DRA (Admin and DRA Analytics). - dsf_single_account_deployment_1_5_7.zip + dsf_single_account_deployment_1_5_7.zip - Sonar Upgrade (Alpha) + Sonar Upgrade (Alpha) All Upgrade of DSF Hub and Agentless Gateway (formerly Sonar). - sonar_upgrade_1_5_7.zip + sonar_upgrade_1_5_7.zip @@ -626,7 +626,7 @@ This mode makes use of the Terraform Command Line Interface (CLI) to deploy and **NOTE:** Update the values for the required parameters to complete the installation: example_name, aws_access_key_id, aws_secret_access_key and region -1. Download the zip file of the example you've chosen (See the [Choosing the Example/Recipe that Fits Your Use Case](#choosing-the-examplerecipe-that-fits-your-use-case) section) from the eDSF Kit GitHub Repository, e.g., if you choose the "sonar_basic_deployment" example, you should download sonar_basic_deployment.zip. +1. Download the zip file of the example you've chosen (See the [Choosing the Example/Recipe that Fits Your Use Case](#choosing-the-examplerecipe-that-fits-your-use-case) section) from the eDSF Kit GitHub Repository, e.g., if you choose the "sonar_basic_deployment" example, you should download sonar_basic_deployment.zip. 2. Unzip the zip file in CLI or using your operating system's UI. For example, in CLI: @@ -729,30 +729,30 @@ This mode can be used if a Linux/Unix machine is not available, or eDSF Kit cann For example: `chmode 400 a_key_pair.pem` -11. Download the zip file of the example you've chosen (See the [Choosing the Example/Recipe that Fits Your Use Case](#choosing-the-examplerecipe-that-fits-your-use-case) section) from the eDSF Kit GitHub Repository, e.g., if you choose the "sonar_basic_deployment" example, you should download sonar_basic_deployment.zip. +11. Download the zip file of the example you've chosen (See the [Choosing the Example/Recipe that Fits Your Use Case](#choosing-the-examplerecipe-that-fits-your-use-case) section) from the eDSF Kit GitHub Repository, e.g., if you choose the "sonar_basic_deployment" example, you should download sonar_basic_deployment.zip. Run: ```bash - wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/poc/sonar_basic_deployment/sonar_basic_deployment_1_5_7.zip + wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/aws/poc/sonar_basic_deployment/sonar_basic_deployment_1_5_7.zip or - wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/poc/sonar_hadr_deployment/sonar_hadr_deployment_1_5_7.zip + wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/aws/poc/sonar_hadr_deployment/sonar_hadr_deployment_1_5_7.zip or - wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/installation/sonar_single_account_deployment/sonar_single_account_deployment_1_5_7.zip + wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/aws/installation/sonar_single_account_deployment/sonar_single_account_deployment_1_5_7.zip or - wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/installation/sonar_multi_account_deployment/sonar_multi_account_deployment_1_5_7.zip + wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/aws/installation/sonar_multi_account_deployment/sonar_multi_account_deployment_1_5_7.zip or - wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/poc/dsf_deployment/dsf_deployment_1_5_7.zip + wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/aws/poc/dsf_deployment/dsf_deployment_1_5_7.zip or - wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/installation/dsf_single_account_deployment/dsf_single_account_deployment_1_5_7.zip + wget https://github.com/imperva/dsfkit/raw/1.5.7/examples/aws/installation/dsf_single_account_deployment/dsf_single_account_deployment_1_5_7.zip ``` 12. Continue by following the [CLI Deployment Mode](#cli-deployment-mode) beginning at step 2. @@ -793,7 +793,7 @@ If you want to use Imperva's Terraform Cloud account, contact Imperva's Technica * Click on the Advanced options button.
![Advanced options](https://user-images.githubusercontent.com/52969528/212977394-60f79882-008b-44ef-bb05-9af629b1a88a.png) - * Enter the path to the example you've chosen (See the [Choosing the Example/Recipe that Fits Your Use Case](#choosing-the-examplerecipe-that-fits-your-use-case) section), e.g., “examples/poc/sonar_basic_deployment”, into the Terraform working directory input field.![Terraform Working Directory](https://github-production-user-asset-6210df.s3.amazonaws.com/87799317/252918341-edfcf6a6-c782-4863-9c55-100f25e680ed.png) + * Enter the path to the example you've chosen (See the [Choosing the Example/Recipe that Fits Your Use Case](#choosing-the-examplerecipe-that-fits-your-use-case) section), e.g., “examples/aws/poc/sonar_basic_deployment”, into the Terraform working directory input field.![Terraform Working Directory](https://github-production-user-asset-6210df.s3.amazonaws.com/87799317/252918341-edfcf6a6-c782-4863-9c55-100f25e680ed.png) ``` >>>> Change the directory in the above screenshot depending on the example you chose ``` @@ -1005,7 +1005,7 @@ In order to be able to download the upgrade software during upgrade, you must re Sonar version constrains can be found in the Sonar Upgrader module's README. -The target version should be specified in the Sonar upgrade example main.tf file, for example: +The target version should be specified in the Sonar upgrade example main.tf file, for example: ```terraform target_version = "4.12.0.10.0" @@ -1020,7 +1020,7 @@ After you have [chosen the upgrade mode](#choosing-the-upgrade-mode), follow the This mode offers a straightforward deployment option that relies on running a Terraform script on the user's computer which must be a Linux/Unix machine, e.g, Mac. This mode makes use of the Terraform Command Line Interface (CLI) to deploy and manage environments. -1. Download the zip file of the Sonar upgrade example: sonar_upgrade_1_5_7.zip. +1. Download the zip file of the Sonar upgrade example: sonar_upgrade_1_5_7.zip. 2. Unzip the zip file in CLI or using your operating system's UI. For example, in CLI: @@ -1115,7 +1115,7 @@ This mode can be used if a Linux/Unix machine is not available, or eDSF Kit cann Information about additional topics can be found in specific examples' READMEs, when relevant. -For example: Sonar Single Account Deployment +For example: Sonar Single Account Deployment These topics include: - Storing Terraform state in S3 bucket