-
Notifications
You must be signed in to change notification settings - Fork 910
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added new phpIPAM serverless third parties solution in blueprints
- Loading branch information
1 parent
c5b1d82
commit 2472385
Showing
15 changed files
with
5,673 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,224 @@ | ||
| # Serverless phpIPAM on Cloud Run | ||
|
|
||
| [phpIPAM](https://phpipam.net/) is an open-source IP address management (IPAM) | ||
| system that can be used to manage IP addresses in both on-premises and cloud | ||
| environments. It is a powerful tool that can help businesses to automate IP | ||
| address management, proactively identify and resolve IP address conflicts, and | ||
| plan for future IP address needs. | ||
|
|
||
| This repository aims to speed up deployment of phpIPAM software on Google Cloud | ||
| Platform Cloud Run serverless product. The web application can be exposed either | ||
| publicly via Global Application Load Balancer or internally via Internal | ||
| Application Load Balancer. More information on the architecture section. | ||
|
|
||
| # Architecture | ||
|
|
||
|  | ||
|
|
||
| The main components that are deployed in this architecture are the following ( | ||
| you can learn about them by following the hyperlinks): | ||
|
|
||
| * [Cloud Run](https://cloud.google.com/run): serverless PaaS offering to host | ||
| containers for web-oriented applications, while offering security, scalability | ||
| and easy versioning | ||
| * [Cloud SQL](https://cloud.google.com/sql): Managed solution for SQL databases | ||
| * [VPC Serverless Connector](https://cloud.google.com/vpc/docs/serverless-vpc-access): | ||
| Solution to access the CloudSQL VPC from Cloud Run, using only internal IP | ||
| addresses | ||
| * \* [Global Application Load Balancer](https://cloud.google.com/load-balancing/docs/https): | ||
| An external Application Load Balancer is a proxy-based Layer 7 load balancer | ||
| that enables you to run and scale your services behind a single external IP | ||
| address. | ||
| * \* [Cloud Armor](https://cloud.google.com/armor/docs/cloud-armor-overview): | ||
| Help protect your applications and websites against denial of service and web | ||
| attacks. | ||
| * \* [Identity Aware Proxy](https://cloud.google.com/iap/docs/concepts-overview): | ||
| IAP lets you establish a central authorization layer for applications accessed | ||
| by HTTPS, so you can use an application-level access control model instead of | ||
| relying on network-level firewalls. | ||
| * \* [Regional Internal Application Load Balancer](https://cloud.google.com/load-balancing/docs/l7-internal): | ||
| A Google Cloud internal Application Load Balancer is a regional proxy-based | ||
| layer 7 load balancer that enables you expose your services behind a single | ||
| internal IP address. | ||
|
|
||
| ##### * Product deployment depends on input variables | ||
|
|
||
| # Setup | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Setting up the project for the deployment | ||
|
|
||
| This example will deploy all its resources into the project defined by | ||
| the `project_id` variable. Please note that we assume this project already | ||
| exists. However, if you provide the appropriate values to the `project_create` | ||
| variable, the project will be created as part of the deployment. | ||
|
|
||
| If `project_create` is left to null, the identity performing the deployment | ||
| needs the `owner` role on the project defined by the `project_id` variable. | ||
| Otherwise, the identity performing the deployment | ||
| needs `resourcemanager.projectCreator` on the resource hierarchy node specified | ||
| by `project_create.parent` and `billing.user` on the billing account specified | ||
| by `project_create.billing_account_id`. | ||
|
|
||
| ## Deployment | ||
|
|
||
| ### Step 0: Cloning the repository | ||
|
|
||
| If you want to deploy from your Cloud Shell, click on the image below, sign in | ||
| if required and when the prompt appears, click on “confirm”. | ||
|
|
||
| [](https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2FGoogleCloudPlatform%2Fcloud-foundation-fabric&cloudshell_workspace=blueprints%2Fthird-party-solutions%2Fwordpress%2Fcloudrun) | ||
|
|
||
| Otherwise, in your console of choice: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/GoogleCloudPlatform/cloud-foundation-fabric | ||
| ``` | ||
|
|
||
| Before you deploy the architecture, you will need at least the following | ||
| information (for more precise configuration see the Variables section): | ||
|
|
||
| * The project ID. | ||
|
|
||
| ### Step 2: Prepare the variables | ||
|
|
||
| Once you have the required information, head back to your cloned repository. | ||
| Make sure you’re in the directory of this tutorial (where this README is in). | ||
|
|
||
| Configure the Terraform variables in your `terraform.tfvars` file. | ||
| See [terraform.tfvars.sample](terraform.tfvars.sample) as starting point - just | ||
| copy it to `terraform.tfvars` and edit the latter. See the variables | ||
| documentation below. | ||
|
|
||
| **Notes**: | ||
|
|
||
| 1. If you have | ||
| the [domain restriction org. policy](https://cloud.google.com/resource-manager/docs/organization-policy/restricting-domains) | ||
| on your organization, you have to edit the `cloud_run_invoker` variable and | ||
| give it a value that will be accepted in accordance to your policy. | ||
| 2. By default, the application will be exposed externally through Global | ||
| Application Load Balancer, for restricting access to specific identities | ||
| please check iap configuration or deploy the application internally via the | ||
| ILB | ||
| 3. Setting the `phpipam_exposure` variable to "INTERNAL" will deploy an Internal | ||
| Application Load Balancer on the same VPC. This might be the preferred option | ||
| for enterprises since it prevents exposing the application publicly still | ||
| allowing internal access through private network (via either VPN and/or | ||
| Interconnect) | ||
|
|
||
| ### Step 3: Deploy resources | ||
|
|
||
| Initialize your Terraform environment and deploy the resources: | ||
|
|
||
| ``` {shell} | ||
| terraform init | ||
| terraform apply | ||
| ``` | ||
|
|
||
| ### Step 4: Use the created resources | ||
|
|
||
| Upon completion, you will see the output with the values for the Cloud Run | ||
| service and the user and password to access the application. | ||
| You can also view it later with: | ||
|
|
||
| ``` {shell} | ||
| terraform output | ||
| # or for the concrete variable: | ||
| terraform output cloud_run_service | ||
| ``` | ||
|
|
||
| Please be aware that password created in the script is not yet configured in the | ||
| application, you will be prompted to insert that during phpIPAM installation | ||
| process at first login. | ||
| To access the newly deployed application follow these instructions: | ||
|
|
||
| 1. Get the default phpIPAM url from the terraform output in the form | ||
| {IP_ADDRESS}.nip.io | ||
| 2. Open your browser at that URL and you will see your phpIPAM installation page | ||
| like the following one: | ||
|
|
||
|  | ||
|
|
||
| 3. Click on "New phpipam installation". On the next page click "Automatic | ||
| database installation", you will be prompted to the following form: | ||
|
|
||
|  | ||
|
|
||
| 4. Insert "admin" as the MySQL username and the password available on the | ||
| terraform output of this command below (without quotes). | ||
| Untick the "Create new database" otherwise you'll get an error during | ||
| installation, leave all the other values as default and then click on " | ||
| Install phpipam database" | ||
|
|
||
| ``` | ||
| terraform output cloudsql_password | ||
| ``` | ||
|
|
||
| 5. After some time a "Database installed successfully!" message should pop up. | ||
| Then click "continue" and you'll be prompted to the last form for configuring | ||
| admin credentials: | ||
|
|
||
|  | ||
|
|
||
| 6. Insert the phpipam password available in the output of the following command | ||
| and choose a site title. Then insert the site url and click "Save | ||
| settings". "A Settings updated, installation complete!" message should pop up | ||
| and clicking "Proceed to login." will redirect you to the login page. | ||
| Be aware this is just a convenient way to have a backup admin password in | ||
| terraform, you could use whatever password you prefer. | ||
|
|
||
| ``` | ||
| terraform output phpipam_password | ||
| ``` | ||
|
|
||
| 7. Insert "admin" as username and the password configured on the previous step | ||
| and after login you'll finally get to the phpIPAM homepage. | ||
|
|
||
|  | ||
|
|
||
| ## Cleaning up your environment | ||
|
|
||
| The easiest way to remove all the deployed resources is to run the following | ||
| command in Cloud Shell: | ||
|
|
||
| ``` {shell} | ||
| terraform destroy | ||
| ``` | ||
|
|
||
| The above command will delete the associated resources so there will be no | ||
| billable charges made afterwards. | ||
| <!-- BEGIN TFDOC --> | ||
| ## Variables | ||
|
|
||
| | name | description | type | required | default | | ||
| |---|---|:---:|:---:|:---:| | ||
| | [prefix](variables.tf#L102) | Prefix used for resource names. | <code>string</code> | ✓ | | | ||
| | [project_id](variables.tf#L126) | Project id, references existing project if `project_create` is null. | <code>string</code> | ✓ | | | ||
| | [cloud_run_invoker](variables.tf#L18) | IAM member authorized to access the end-point (for example, 'user:YOUR_IAM_USER' for only you or 'allUsers' for everyone). | <code>string</code> | | <code>"allUsers"</code> | | ||
| | [cloudsql_password](variables.tf#L24) | CloudSQL password (will be randomly generated by default). | <code>string</code> | | <code>null</code> | | ||
| | [connector](variables.tf#L30) | Existing VPC serverless connector to use if not creating a new one. | <code>string</code> | | <code>null</code> | | ||
| | [create_connector](variables.tf#L36) | Should a VPC serverless connector be created or not. | <code>bool</code> | | <code>true</code> | | ||
| | [custom_domain](variables.tf#L42) | Cloud Run service custom domain for GLB. | <code>string</code> | | <code>null</code> | | ||
| | [iap](variables.tf#L48) | Identity-Aware Proxy for Cloud Run in the LB. | <code title="object({ enabled = optional(bool, false) app_title = optional(string, "Cloud Run Explore Application") oauth2_client_name = optional(string, "Test Client") email = optional(string) })">object({…})</code> | | <code>{}</code> | | ||
| | [ip_ranges](variables.tf#L60) | CIDR blocks: VPC serverless connector, Private Service Access(PSA) for CloudSQL, CloudSQL VPC. | <code title="object({ connector = string psa = string ilb = string })">object({…})</code> | | <code title="{ connector = "10.8.0.0/28" psa = "10.60.0.0/24" ilb = "10.128.0.0/28" }">{…}</code> | | ||
| | [phpipam_config](variables.tf#L74) | PHPIpam configuration. | <code title="object({ image = optional(string, "phpipam/phpipam-www:latest") port = optional(number, 80) })">object({…})</code> | | <code title="{ image = "phpipam/phpipam-www:latest" port = 80 }">{…}</code> | | ||
| | [phpipam_exposure](variables.tf#L86) | Whether to expose the application publicly via GLB or internally via ILB, default GLB. | <code>string</code> | | <code>"EXTERNAL"</code> | | ||
| | [phpipam_password](variables.tf#L96) | Password for the phpipam user (will be randomly generated by default). | <code>string</code> | | <code>null</code> | | ||
| | [principals](variables.tf#L111) | List of users to give rights to (CloudSQL admin, client and instanceUser, Logging admin, Service Account User and TokenCreator), eg '[email protected]'. | <code>list(string)</code> | | <code>[]</code> | | ||
| | [project_create](variables.tf#L117) | Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format. | <code title="object({ billing_account_id = string parent = string })">object({…})</code> | | <code>null</code> | | ||
| | [region](variables.tf#L131) | Region for the created resources. | <code>string</code> | | <code>"europe-west4"</code> | | ||
| | [security_policy](variables.tf#L137) | Security policy (Cloud Armor) to enforce in the LB. | <code title="object({ enabled = optional(bool, false) ip_blacklist = optional(list(string), ["*"]) path_blocked = optional(string, "/login.html") })">object({…})</code> | | <code>{}</code> | | ||
| | [vpc_config](variables.tf#L147) | VPC Network and subnetwork self links for internal LB setup. | <code title="object({ network = string subnetwork = string })">object({…})</code> | | <code>null</code> | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | name | description | sensitive | | ||
| |---|---|:---:| | ||
| | [cloud_run_service](outputs.tf#L17) | CloudRun service URL. | ✓ | | ||
| | [cloudsql_password](outputs.tf#L23) | CloudSQL password. | ✓ | | ||
| | [phpipam_ip_address](outputs.tf#L29) | PHPIPAM IP Address either external or internal according to app exposure. | | | ||
| | [phpipam_password](outputs.tf#L34) | PHPIPAM user password. | ✓ | | ||
| | [phpipam_url](outputs.tf#L40) | PHPIPAM website url. | | | ||
| | [phpipam_user](outputs.tf#L45) | PHPIPAM username. | | | ||
| <!-- END TFDOC --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /** | ||
| * Copyright 2023 Google LLC | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| # Set up CloudSQL | ||
| module "cloudsql" { | ||
| source = "../../../modules/cloudsql-instance" | ||
| project_id = module.project.project_id | ||
| prefix = var.prefix | ||
| network = local.network | ||
| name = "${var.prefix}-mysql" | ||
| region = var.region | ||
| database_version = local.cloudsql_conf.database_version | ||
| tier = local.cloudsql_conf.tier | ||
| databases = [local.cloudsql_conf.db] | ||
| users = { | ||
| "${local.cloudsql_conf.user}" = var.cloudsql_password | ||
| } | ||
| } |
Oops, something went wrong.