Merge pull request #818 from skalolazka/example-wordpress
Example wordpress
This commit is contained in:
Natalia Strelkova
GitHub
commit
d33e04ce27
|
|
@ -0,0 +1,139 @@
|
|||
# Wordpress deployment on Cloud Run
|
||||
|
||||
43% of the Web is built on Wordpress. Because of its simplicity and versatility, Wordpress can be used for internal websites as well as customer facing e-commerce platforms in small to large businesses, while still offering security.
|
||||
|
||||
This repository contains the necessary Terraform files to deploy a functioning new Wordpress website exposed to the public internet with minimal technical overhead.
|
||||
|
||||
This architecture can be used for the following use cases and more:
|
||||
|
||||
* Blog
|
||||
* Intranet / internal Wiki
|
||||
* E-commerce platform
|
||||
|
||||
# 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
|
||||
|
||||
# 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”.
|
||||
|
||||
[<p align="center"> <img alt="Open Cloudshell" width = "300px" src="images/button.png" /> </p>](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2FGoogleCloudPlatform%2Fcloud-foundation-fabric&cloudshell_print=cloud-shell-readme.txt&cloudshell_working_dir=blueprints%2Fthird-party-solutions%2Fwordpress)
|
||||
|
||||
Otherwise, in your console of choice:
|
||||
``` {shell}
|
||||
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.
|
||||
* A Google Cloud Registry path to a Wordpress container image.
|
||||
|
||||
### Step 1: Add Wordpress image
|
||||
|
||||
In order to deploy the Wordpress service to Cloud Run, you need to store the [Wordpress image](https://hub.docker.com/r/bitnami/wordpress/) in Google Cloud Registry (GCR).
|
||||
|
||||
Make sure that the Google Container Registry API is enabled and run the following commands in your Cloud Shell environment with your `project_id` in place of the `MY_PROJECT` placeholder:
|
||||
|
||||
``` {shell}
|
||||
docker pull bitnami/wordpress:6.0.2
|
||||
docker tag bitnami/wordpress gcr.io/MY_PROJECT/wordpress
|
||||
docker push gcr.io/MY_PROJECT/wordpress
|
||||
```
|
||||
|
||||
**Note**: This example has been built for this particular Docker image. If you decide to use another one, this example might not work (or you can edit the variables in the Terraform files).
|
||||
|
||||
### 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 will want to change your admin password later on, please note that it will only work in the admin interface of Wordpress, but not with redeploying with Terraform, since Wordpress writes that password into the database upon installation and ignores the environment variables (that you can change with Terraform) after that.
|
||||
2. 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.
|
||||
|
||||
### Step 3: Deploy resources
|
||||
|
||||
Initialize your Terraform environment and deploy the resources:
|
||||
|
||||
``` {shell}
|
||||
terraform init
|
||||
terraform apply
|
||||
```
|
||||
The resource creation will take a few minutes.
|
||||
|
||||
**Note**: you might get the following error (or a similar one):
|
||||
``` {shell}
|
||||
│ Error: resource is in failed state "Ready:False", message: Revision '...' is not ready and cannot serve traffic.│
|
||||
```
|
||||
You might try to reapply at this point, the Cloud Run service just needs several minutes.
|
||||
|
||||
### 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 `/admin` part of the website. You can also view it later with:
|
||||
``` {shell}
|
||||
terraform output
|
||||
# or for the concrete variable:
|
||||
terraform output cloud_run_service
|
||||
```
|
||||
1. Open your browser at the URL that you get with that last command, and you will see your Wordpress installation.
|
||||
2. Add "/admin" in the end of the URL and log in to the admin interface, using the outputs "wp_user" and "wp_password".
|
||||
|
||||
## 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 |
|
||||
|---|---|:---:|:---:|:---:|
|
||||
| [project_id](variables.tf#L72) | Project id, references existing project if `project_create` is null. | <code>string</code> | ✓ | |
|
||||
| [wordpress_image](variables.tf#L83) | Image to run with Cloud Run, starts with \"gcr.io\" | <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> |
|
||||
| [create_connector](variables.tf#L30) | Should a VPC serverless connector be created or not | <code>bool</code> | | <code>true</code> |
|
||||
| [ip_ranges](variables.tf#L37) | CIDR blocks: VPC serverless connector, Private Service Access(PSA) for CloudSQL, CloudSQL VPC | <code title="object({ connector = string psa = string sql_vpc = string })">object({…})</code> | | <code title="{ connector = "10.8.0.0/28" psa = "10.60.0.0/24" sql_vpc = "10.0.0.0/20" }">{…}</code> |
|
||||
| [prefix](variables.tf#L51) | Unique prefix used for resource names. Not used for project if 'project_create' is null. | <code>string</code> | | <code>""</code> |
|
||||
| [principals](variables.tf#L57) | List of users to give rights to (CloudSQL admin, client and instanceUser, Logging admin, Service Account User and TokenCreator), eg 'user@domain.com'. | <code>list(string)</code> | | <code>[]</code> |
|
||||
| [project_create](variables.tf#L63) | 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#L77) | Region for the created resources | <code>string</code> | | <code>"europe-west4"</code> |
|
||||
| [wordpress_password](variables.tf#L94) | Password for the Wordpress user (will be randomly generated by default) | <code>string</code> | | <code>null</code> |
|
||||
| [wordpress_port](variables.tf#L88) | Port for the Wordpress image | <code>number</code> | | <code>8080</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
| name | description | sensitive |
|
||||
|---|---|:---:|
|
||||
| [cloud_run_service](outputs.tf#L17) | CloudRun service URL | ✓ |
|
||||
| [cloudsql_password](outputs.tf#L23) | CloudSQL password | ✓ |
|
||||
| [wp_password](outputs.tf#L34) | Wordpress user password | ✓ |
|
||||
| [wp_user](outputs.tf#L29) | Wordpress username | |
|
||||
|
||||
<!-- END TFDOC -->
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
/**
|
||||
* Copyright 2022 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.
|
||||
*/
|
||||
|
||||
|
||||
resource "random_password" "cloudsql_password" {
|
||||
length = 8
|
||||
}
|
||||
|
||||
# create a VPC for CloudSQL
|
||||
module "vpc" {
|
||||
source = "../../../../modules/net-vpc"
|
||||
project_id = module.project.project_id
|
||||
name = "${local.prefix}sql-vpc"
|
||||
subnets = [
|
||||
{
|
||||
ip_cidr_range = var.ip_ranges.sql_vpc
|
||||
name = "subnet"
|
||||
region = var.region
|
||||
secondary_ip_range = {}
|
||||
}
|
||||
]
|
||||
|
||||
# Private Service Access
|
||||
psa_config = {
|
||||
ranges = {
|
||||
cloud-sql = var.ip_ranges.psa
|
||||
}
|
||||
routes = null
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
# create a VPC connector for the ClouSQL VPC
|
||||
resource "google_vpc_access_connector" "connector" {
|
||||
count = var.create_connector ? 1 : 0
|
||||
project = module.project.project_id
|
||||
name = "${local.prefix}wp-connector"
|
||||
region = var.region
|
||||
ip_cidr_range = var.ip_ranges.connector
|
||||
network = module.vpc.self_link
|
||||
}
|
||||
|
||||
|
||||
# Set up CloudSQL
|
||||
module "cloudsql" {
|
||||
source = "../../../../modules/cloudsql-instance"
|
||||
project_id = module.project.project_id
|
||||
network = module.vpc.self_link
|
||||
name = "${local.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}" = "${local.cloudsql_conf.pass}"
|
||||
}
|
||||
}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
|
|
@ -0,0 +1,121 @@
|
|||
/**
|
||||
* Copyright 2022 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.
|
||||
*/
|
||||
|
||||
|
||||
locals {
|
||||
all_principals_iam = [for k in var.principals : "user:${k}"]
|
||||
cloudsql_conf = {
|
||||
database_version = "MYSQL_8_0"
|
||||
tier = "db-g1-small"
|
||||
db = "wp-mysql"
|
||||
user = "admin"
|
||||
pass = var.cloudsql_password == null ? random_password.cloudsql_password.result : var.cloudsql_password
|
||||
}
|
||||
iam = {
|
||||
# CloudSQL
|
||||
"roles/cloudsql.admin" = local.all_principals_iam
|
||||
"roles/cloudsql.client" = local.all_principals_iam
|
||||
"roles/cloudsql.instanceUser" = local.all_principals_iam
|
||||
# common roles
|
||||
"roles/logging.admin" = local.all_principals_iam
|
||||
"roles/iam.serviceAccountUser" = local.all_principals_iam
|
||||
"roles/iam.serviceAccountTokenCreator" = local.all_principals_iam
|
||||
}
|
||||
connector = var.connector == null ? google_vpc_access_connector.connector.0.self_link : var.connector
|
||||
prefix = var.prefix == null ? "" : "${var.prefix}-"
|
||||
wp_user = "user"
|
||||
wp_pass = var.wordpress_password == null ? random_password.wp_password.result : var.wordpress_password
|
||||
}
|
||||
|
||||
|
||||
# either create a project or set up the given one
|
||||
module "project" {
|
||||
source = "../../../../modules/project"
|
||||
name = var.project_id
|
||||
parent = try(var.project_create.parent, null)
|
||||
billing_account = try(var.project_create.billing_account_id, null)
|
||||
project_create = var.project_create != null
|
||||
prefix = var.project_create == null ? null : var.prefix
|
||||
iam = var.project_create != null ? local.iam : {}
|
||||
iam_additive = var.project_create == null ? local.iam : {}
|
||||
services = [
|
||||
"run.googleapis.com",
|
||||
"logging.googleapis.com",
|
||||
"monitoring.googleapis.com",
|
||||
"sqladmin.googleapis.com",
|
||||
"sql-component.googleapis.com",
|
||||
"vpcaccess.googleapis.com",
|
||||
"servicenetworking.googleapis.com"
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
resource "random_password" "wp_password" {
|
||||
length = 8
|
||||
}
|
||||
|
||||
|
||||
# create the Cloud Run service
|
||||
module "cloud_run" {
|
||||
source = "../../../../modules/cloud-run"
|
||||
project_id = module.project.project_id
|
||||
name = "${local.prefix}cr-wordpress"
|
||||
region = var.region
|
||||
|
||||
containers = [{
|
||||
image = var.wordpress_image
|
||||
ports = [{
|
||||
name = "http1"
|
||||
protocol = null
|
||||
container_port = var.wordpress_port
|
||||
}]
|
||||
options = {
|
||||
command = null
|
||||
args = null
|
||||
env_from = null
|
||||
# set up the database connection
|
||||
env = {
|
||||
"APACHE_HTTP_PORT_NUMBER" : var.wordpress_port
|
||||
"WORDPRESS_DATABASE_HOST" : module.cloudsql.ip
|
||||
"WORDPRESS_DATABASE_NAME" : local.cloudsql_conf.db
|
||||
"WORDPRESS_DATABASE_USER" : local.cloudsql_conf.user
|
||||
"WORDPRESS_DATABASE_PASSWORD" : local.cloudsql_conf.pass
|
||||
"WORDPRESS_USERNAME" : local.wp_user
|
||||
"WORDPRESS_PASSWORD" : local.wp_pass
|
||||
}
|
||||
}
|
||||
resources = null
|
||||
volume_mounts = null
|
||||
}]
|
||||
|
||||
iam = {
|
||||
"roles/run.invoker" : [var.cloud_run_invoker]
|
||||
}
|
||||
|
||||
revision_annotations = {
|
||||
autoscaling = {
|
||||
min_scale = 1
|
||||
max_scale = 2
|
||||
}
|
||||
# connect to CloudSQL
|
||||
cloudsql_instances = [module.cloudsql.connection_name]
|
||||
vpcaccess_connector = null
|
||||
# allow all traffic
|
||||
vpcaccess_egress = "all-traffic"
|
||||
vpcaccess_connector = local.connector
|
||||
}
|
||||
ingress_settings = "all"
|
||||
}
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
/**
|
||||
* Copyright 2022 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.
|
||||
*/
|
||||
|
||||
output "cloud_run_service" {
|
||||
description = "CloudRun service URL"
|
||||
value = module.cloud_run.service.status[0].url
|
||||
sensitive = true
|
||||
}
|
||||
|
||||
output "cloudsql_password" {
|
||||
description = "CloudSQL password"
|
||||
value = local.cloudsql_conf.pass
|
||||
sensitive = true
|
||||
}
|
||||
|
||||
output "wp_user" {
|
||||
description = "Wordpress username"
|
||||
value = local.wp_user
|
||||
}
|
||||
|
||||
output "wp_password" {
|
||||
description = "Wordpress user password"
|
||||
value = local.wp_pass
|
||||
sensitive = true
|
||||
}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
prefix = "wp"
|
||||
project_id = "my-wordpress-project"
|
||||
wordpress_image = "gcr.io/my-wordpress-project/wordpress"
|
||||
|
|
@ -0,0 +1,104 @@
|
|||
/**
|
||||
* Copyright 2022 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.
|
||||
*/
|
||||
|
||||
# Documentation: https://cloud.google.com/run/docs/securing/managing-access#making_a_service_public
|
||||
variable "cloud_run_invoker" {
|
||||
type = string
|
||||
description = "IAM member authorized to access the end-point (for example, 'user:YOUR_IAM_USER' for only you or 'allUsers' for everyone)"
|
||||
default = "allUsers"
|
||||
}
|
||||
|
||||
variable "cloudsql_password" {
|
||||
type = string
|
||||
description = "CloudSQL password (will be randomly generated by default)"
|
||||
default = null
|
||||
}
|
||||
|
||||
variable "connector" {
|
||||
type = string
|
||||
description = "Existing VPC serverless connector to use if not creating a new one"
|
||||
default = null
|
||||
}
|
||||
|
||||
variable "create_connector" {
|
||||
type = bool
|
||||
description = "Should a VPC serverless connector be created or not"
|
||||
default = true
|
||||
}
|
||||
|
||||
# PSA: documentation: https://cloud.google.com/vpc/docs/configure-private-services-access#allocating-range
|
||||
variable "ip_ranges" {
|
||||
description = "CIDR blocks: VPC serverless connector, Private Service Access(PSA) for CloudSQL, CloudSQL VPC"
|
||||
type = object({
|
||||
connector = string
|
||||
psa = string
|
||||
sql_vpc = string
|
||||
})
|
||||
default = {
|
||||
connector = "10.8.0.0/28"
|
||||
psa = "10.60.0.0/24"
|
||||
sql_vpc = "10.0.0.0/20"
|
||||
}
|
||||
}
|
||||
|
||||
variable "prefix" {
|
||||
description = "Unique prefix used for resource names. Not used for project if 'project_create' is null."
|
||||
type = string
|
||||
default = ""
|
||||
}
|
||||
|
||||
variable "principals" {
|
||||
description = "List of users to give rights to (CloudSQL admin, client and instanceUser, Logging admin, Service Account User and TokenCreator), eg 'user@domain.com'."
|
||||
type = list(string)
|
||||
default = []
|
||||
}
|
||||
|
||||
variable "project_create" {
|
||||
description = "Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format."
|
||||
type = object({
|
||||
billing_account_id = string
|
||||
parent = string
|
||||
})
|
||||
default = null
|
||||
}
|
||||
|
||||
variable "project_id" {
|
||||
description = "Project id, references existing project if `project_create` is null."
|
||||
type = string
|
||||
}
|
||||
|
||||
variable "region" {
|
||||
type = string
|
||||
description = "Region for the created resources"
|
||||
default = "europe-west4"
|
||||
}
|
||||
|
||||
variable "wordpress_image" {
|
||||
type = string
|
||||
description = "Image to run with Cloud Run, starts with \"gcr.io\""
|
||||
}
|
||||
|
||||
variable "wordpress_port" {
|
||||
type = number
|
||||
description = "Port for the Wordpress image"
|
||||
default = 8080
|
||||
}
|
||||
|
||||
variable "wordpress_password" {
|
||||
type = string
|
||||
description = "Password for the Wordpress user (will be randomly generated by default)"
|
||||
default = null
|
||||
}
|
||||
Loading…
Reference in New Issue