Merge pull request #18 from amido/feature/deployment

Author: ElvenSpellmaker

.gitignore

@@ -10,6 +10,9 @@
 
 java/target/
 java/build/
+java/.classpath
+java/.project
+java/.settings/
 
 lombok.config
 .terraform

build/azDevops/azure/azure-pipelines-javaspring-k8s.yml

@@ -5,6 +5,10 @@ parameters:
   project_root_dir: ""
   dependsOn: "GetPackage"
   download_devops: true
+  # PR / Branch vars
+  source_branch_ref: ""
+  target_branch_ref: ""
+  pullrequest_number: ""
   # Custom registry (eg. private)
   customRegistry: ""
   # Docker Config
@@ -20,6 +24,8 @@ parameters:
   #  Static Code Analysis
   static_code_analysis: false
   sonar_container: ""
+  sonar_pullrequest_provider: ""
+  sonar_remote_repo: ""
   # Linting and formatting validation
   lint_formatting: ""
   shared_eslint_config: ""
@@ -41,10 +47,6 @@ parameters:
   git_release_tag: ""
 
 steps:
-  - bash: |
-      echo '##vso[build.updatebuildnumber]${{ parameters.docker_imagetag }}'
-    displayName: 'Update: Build Number'
-
   - task: Cache@2
     inputs:
       key: 'maven | "$(Agent.OS)" | ${{ parameters.project_root_dir }}/pom.xml'
@@ -146,15 +148,58 @@ steps:
 
   # SonarCloud
   - ${{ if eq(parameters.static_code_analysis, true) }}:
+      - bash: |
+          set -euxo pipefail
+          function strip_refs()
+          {
+            local BRANCH_REF="$1"
+
+            RETURN_BRANCH="$(sed -e "s%^refs/\(heads\|tags\)/%%" <<< $BRANCH_REF)"
+          }
+
+          strip_refs "${{ parameters.source_branch_ref }}"
+          SOURCE_BRANCH=$RETURN_BRANCH
+
+          strip_refs "${{ parameters.target_branch_ref }}"
+          TARGET_BRANCH=$RETURN_BRANCH
+
+          if [ -z "${{ parameters.pullrequest_number }}" ]; then
+            EXTRA_SONAR_ARGUMENTS="-Dsonar.branch.name='$SOURCE_BRANCH'"
+            EXTRA_SONAR_ARGUMENTS="${EXTRA_SONAR_ARGUMENTS} -Dsonar.branch.target='$TARGET_BRANCH'"
+          else
+            PROVIDER_LOWERCASED="$(tr '[:upper:]' '[:lower:]' <<< "${{ parameters.sonar_pullrequest_provider }}")"
+
+            EXTRA_SONAR_ARGUMENTS="-Dsonar.pullrequest.key='${{ parameters.pullrequest_number }}'"
+            EXTRA_SONAR_ARGUMENTS="${EXTRA_SONAR_ARGUMENTS} -Dsonar.pullrequest.branch='$SOURCE_BRANCH'"
+            EXTRA_SONAR_ARGUMENTS="${EXTRA_SONAR_ARGUMENTS} -Dsonar.pullrequest.provider='$PROVIDER_LOWERCASED'"
+            EXTRA_SONAR_ARGUMENTS="${EXTRA_SONAR_ARGUMENTS} -Dsonar.pullrequest.base='$TARGET_BRANCH'"
+
+            if [ "$PROVIDER_LOWERCASED" == 'github' ]; then
+              EXTRA_SONAR_ARGUMENTS="${EXTRA_SONAR_ARGUMENTS} -Dsonar.pullrequest.github.repository='${{ parameters.sonar_remote_repo }}'"
+            fi
+          fi
+
+          echo "##vso[task.setvariable variable=bash_extra_sonar_arguments]$EXTRA_SONAR_ARGUMENTS"
+        displayName: "Sonar: Extra Sonar Arguments"
+
       - template: azDevOps/azure/templates/v2/steps/test-static-code-sonar.yml@templates
         parameters:
           working_directory: "${{ parameters.project_root_dir }}"
           target_container: "${{ parameters.sonar_container }}"
+          extra_arguments: "$(bash_extra_sonar_arguments)"
           env_vars: {
-            SONAR_PULL_REQUEST: "$(System.PullRequest.PullRequestNumber)",
-            SONAR_BRANCH_NAME: "$(System.PullRequest.SourceBranch)",
-            SONAR_PR_PROVIDER: "GitHub",
-            SONAR_GITHUB_REPO: "amido/stacks-java",
+            SONAR_HOST_URL: "https://sonarcloud.io",
+            SONAR_TOKEN: $SONAR_TOKEN,
+            SONAR_PROJECT_KEY: $SONAR_PROJECT_KEY,
+            SONAR_ORGANIZATION: $SONAR_ORGANIZATION,
+            SONAR_PROJECT_NAME: $SONAR_PROJECT_NAME,
+            BUILD_NUMBER: $(docker_image_tag),
+            SONAR_SCANNER_OPTS: "",
+            # PR Sonar Variables
+            # SONAR_BRANCH_NAME: "${{ parameters.branch_ref }}",
+            # SONAR_PULL_REQUEST: "${{ parameters.pull_request_number }}",
+            # SONAR_PR_PROVIDER: "GitHub",
+            # SONAR_GITHUB_REPO: "amido/stacks-java",
           }
 
   - ${{ if eq(parameters.docker_build, true) }}:

build/azDevops/azure/templates/steps/build-java.yml

@@ -0,0 +1,18 @@
+# Example of further extensions to Stacks Core templates
+# Potential user defined extensions
+data "azurerm_application_insights" "example" {
+  name                = var.core_resource_group
+  resource_group_name = var.app_insights_name
+}
+
+output "app_insights_instrumentation_key" {
+  description = "App Insights key for downstream deploymnent use"
+  value       = data.azurerm_application_insights.example.instrumentation_key
+  sensitive   = true
+}
+
+variable app_insights_name {
+  type        = string
+  default     = ""
+  description = "app insights name for key retriaval in memory"
+}

deploy/azure/app/kube/backend.local.tfvars

@@ -1,7 +1,7 @@
 # We are keeping this as a lookup
-# since proper conventions for naming of resources should be followed 
+# since proper conventions for naming of resources should be followed
 # and things can always be looked up without resorting to cross state searches
 data "azurerm_public_ip" "app_gateway" {
   name                = var.app_gateway_frontend_ip_name
-  resource_group_name = var.resource_group_name
+  resource_group_name = var.core_resource_group
 }

deploy/azure/app/kube/custom.tf

@@ -5,64 +5,36 @@
 
 data "azurerm_client_config" "current" {}
 
-# Naming convention 
+# Naming convention
 module "default_label" {
   source     = "git::https://github.com/cloudposse/terraform-null-label.git?ref=0.16.0"
   namespace  = "${var.name_company}-${var.name_project}"
   stage      = var.stage
-  name       = "${lookup(var.location_name_map, var.resource_group_location, "uksouth")}-${var.name_component}"
+  name       = "${lookup(var.location_name_map, var.resource_group_location, "uksouth")}-${var.name_domain}"
   attributes = var.attributes
   delimiter  = "-"
   tags       = var.tags
 }
 
-locals {
-  create_resource_group = var.use_existing_resource_group && var.resource_group_name != "" ? false : true
-  resource_group_name = var.use_existing_resource_group && var.resource_group_name != "" ? var.resource_group_name : module.default_label.id
-}
-
-resource "azurerm_resource_group" "default" {
-  count    = local.create_resource_group ? 1 : 0
-  name     = local.resource_group_name
-  location = var.resource_group_location
-  tags     = var.tags
-}
-
-####
-# app level DNS can/should be controlled from here
-# an alternative way of managing this would be through K8s operators
-# [TODO]: examples can be found in the deploy folders
-#### 
-resource "azurerm_dns_a_record" "default" {
-  name                = var.dns_record
-  zone_name           = var.dns_zone_name
-  resource_group_name = local.resource_group_name
-  ttl                 = 300
-  records             = [data.azurerm_public_ip.app_gateway.ip_address]
-}
-
-module "cosmosdb" {
-  source                               = "git::https://github.com/amido/stacks-terraform//azurerm/modules/azurerm-cosmosdb?ref=v1.1.0"
+module "app" {
+  source                               = "git::https://github.com/amido/stacks-terraform//azurerm/modules/azurerm-server-side-app?ref=v1.3.1"
+  create_cdn_endpoint                  = var.create_cdn_endpoint
   create_cosmosdb                      = var.create_cosmosdb
   resource_namer                       = module.default_label.id
-  name_environment                     = "dev-feature"
-  name_project                         = var.name_project
-  name_company                         = var.name_company
-  name_component                       = var.name_component
-  resource_group_name                  = local.resource_group_name
-  cosmosdb_sql_container               = "Menu"
-  cosmosdb_sql_container_partition_key = "/id"
-  cosmosdb_kind                        = "GlobalDocumentDB"
-  cosmosdb_offer_type                  = "Standard"
+  resource_group_location              = var.resource_group_location
+  resource_tags                        = module.default_label.tags
+  cosmosdb_sql_container               = var.cosmosdb_sql_container
+  cosmosdb_sql_container_partition_key = var.cosmosdb_sql_container_partition_key
+  cosmosdb_kind                        = var.cosmosdb_kind
+  cosmosdb_offer_type                  = var.cosmosdb_offer_type
+  create_cache                         = var.create_cache
+  create_dns_record                    = var.create_dns_record
+  dns_record                           = var.dns_record
+  dns_zone_name                        = var.dns_zone_name
+  core_resource_group                  = var.core_resource_group
+  dns_zone_resource_group              = var.dns_zone_resource_group != "" ? var.dns_zone_resource_group : var.core_resource_group
+  dns_a_records                        = [data.azurerm_public_ip.app_gateway.ip_address]
+  subscription_id                      = data.azurerm_client_config.current.subscription_id
+  # Alternatively if you want you can pass in the IP directly and remove the need for a lookup
+  # dns_a_records                        = ["0.1.23.45"]
 }
-
-####
-# Additional modules need to go here as they can be re-used across app deployments
-#### 
-# module "observability" {
-#   source = "git://...." 
-# }
-
-#### 
-# Additional user defined resources or modules can go here
-####

deploy/azure/app/kube/lookups.tf

@@ -1,20 +1,41 @@
 output "cosmosdb_database_name" {
   description = "CosmosDB Database name"
-  value       = module.cosmosdb.cosmosdb_database_name
+  value       = module.app.cosmosdb_database_name
 }
 
 output "cosmosdb_account_name" {
   description = "CosmosDB account name"
-  value       = module.cosmosdb.cosmosdb_account_name
+  value       = module.app.cosmosdb_account_name
 }
 
 output "cosmosdb_endpoint" {
   description = "Endpoint for accessing the DB CRUD"
-  value       = module.cosmosdb.cosmosdb_endpoint
+  value       = module.app.cosmosdb_endpoint
 }
 
 output "cosmosdb_primary_master_key" {
   description = "Primary Key for accessing the DB CRUD, should only be used in applications running outside of AzureCloud"
   sensitive   = true
-  value       = module.cosmosdb.cosmosdb_primary_master_key
+  value       = module.app.cosmosdb_primary_master_key
+}
+
+output "redis_cache_key" {
+  description = "Primary Key for accessing the RedisCache, should only be used in applications running outside of AzureCloud"
+  sensitive   = true
+  value       = module.app.redis_cache_key
+}
+
+output "redis_cache_hostname" {
+  description = "Primary Hostname endpoint for Redis Cache"
+  value       = module.app.redis_cache_hostname
+}
+
+output "resource_group" {
+  description = "Resource group name for the app"
+  value       = module.app.resource_group
+}
+
+output "dns_name" {
+  description = "DNS Name if created"
+  value       = module.app.dns_name
 }

deploy/azure/app/kube/main.tf

@@ -22,6 +22,11 @@ variable "name_component" {
   default = "replace_component_name"
 }
 
+variable "name_domain" {
+  type    = string
+  default = "replace_domain_name"
+}
+
 variable "stage" {
   type    = string
   default = "dev"
@@ -36,7 +41,7 @@ variable "tags" {
   default = {}
 }
 
-# Each region must have corresponding a shortend name for resource naming purposes 
+# Each region must have corresponding a shortend name for resource naming purposes
 variable "location_name_map" {
   type = map(string)
 
@@ -62,44 +67,83 @@ variable "resource_group_location" {
   default = "uksouth"
 }
 
-variable "resource_group_name" {
-  description = "RG name of where you want to be deploying app level resources, can be left blank and "
-  type = string   
-}
-
 variable "app_gateway_frontend_ip_name" {
   description = ""
-  type = string  
+  type        = string
 }
 
 variable "dns_record" {
   description = ""
-  type = string
-  default = "app" 
+  type        = string
+  default     = "app"
 }
 
-
 variable "dns_zone_name" {
   type    = string
   default = "nonprod.amidostacks.com"
 }
 
+variable "dns_zone_resource_group" {
+  type    = string
+  default = ""
+}
+
+variable "core_resource_group" {
+  type = string
+}
+
 variable "internal_dns_zone_name" {
   type    = string
   default = "nonprod.amidostacks.internal"
 }
 
+
 ###########################
 # CONDITIONAL SETTINGS
 ##########################
 variable "create_cosmosdb" {
   description = "Whether to create a cosmosdb or not for this application"
+  type        = bool
+  default     = true
+}
+
+variable "create_cache" {
+  type        = bool
+  description = "Whether to create a RedisCache"
+  default     = false
+}
+
+variable "create_dns_record" {
   type    = bool
-  default = true
+  default = false
 }
 
-variable "use_existing_resource_group" {
-  description = "Whether to create a resource group for application level resources, if set to true and `resource_group_name` is not specified it will create a resource group for you. Ensure you specify resource group when setting to true"
+variable create_cdn_endpoint {
   type    = bool
-  default = true
+  default = false
+}
+###########################
+# CosmosDB SETTINGS
+##########################
+variable "cosmosdb_sql_container" {
+  type        = string
+  description = "Specify the SQLContainer name in CosmosDB"
+  default     = "Menu"
+}
+
+variable "cosmosdb_sql_container_partition_key" {
+  type        = string
+  default     = "/id"
+  description = "Specify partition key"
+}
+
+variable "cosmosdb_kind" {
+  type        = string
+  default     = "GlobalDocumentDB"
+  description = "Specify the CosmosDB kind"
+}
+variable "cosmosdb_offer_type" {
+  type        = string
+  default     = "Standard"
+  description = "Specify the offer type"
 }