Google Cloud Functions
This tutorial will get you started with Harness Continuous Delivery (CD). We will guide you through deploying new Google Cloud Functions to Google Cloud using a Harness CD pipeline.
Harness CD pipelines help you to orchestrate and automate your Google Cloud Function deployments and push updated functions to Google Cloud.
Pipelines allow extensive control over how you want to progress functions through various dev/test/stage/prod environments while running a variety of scans and tests to ensure your quality and stability standards.
Before you begin
Verify that you have the following:
- Obtain GitHub personal access token with the repo scope. See the GitHub documentation on creating a personal access token.
- A Kubernetes cluster. Use your own Kubernetes cluster or we recommend using K3D for installing a Harness delegate.
- Check Delegate system requirements.
- Install the Docker in order to install the Docker delegate.
- Fork the harnessed-example-apps repository through the GitHub website.
- For details on Forking a GitHub repository, go to GitHub docs for more information on forking a GitHub repository.
- Google Cloud Function and Google Cloud Storage permissions. Harness supports Google Cloud Functions 1st gen and 2nd gen. There are minor differences in the permissions required by each generation. For a detailed breakdown, go to Access control with IAM from Google.
Google Cloud Function Support
Cloud Functions offers two product versions: Cloud Functions 1st gen, the original version, and Cloud Functions 2nd gen, a new version built on Cloud Run and Eventarc to provide an enhanced feature set. Harness supports deploying Google Functions 1st gen and 2nd gen.
To get more information on Google Functions 1st gen and 2nd gen, go to Cloud Functions version comparison.
We suggest opting for Cloud Functions 2nd gen whenever feasible for new functions, as it offers a range of additional features. For more information, go to New in Cloud Functions(2nd Gen).
Cloud Functions Limitations
- For Google Cloud Functions 2nd gen, Harness does not support Google Cloud Source Repository at this time. Only Google Cloud Storage is supported.
- For Google Cloud Functions 1st gen, Harness supports both Google Cloud Storage and Google Cloud Source.
Steps to perform on Google Cloud
- Make sure your Google Cloud account credentials have the required permissions for Google Cloud Function and Google Cloud Storage, as mentioned above.
- Download the hello_world.zip for 1st gen and helloHttp.zip for 2nd gen files from GitHub.
- Log into the Google Cloud console and create a Google Cloud Storage bucket. For details, go to Create a new bucket.
- Once the bucket is created, select UPLOAD FILES and upload the file hello_world.zip for 1st gen or helloHttp.zip for 2nd gen.
- 2nd Gen
- 1st Gen
Getting Started with Harness CD
- Log into Harness.
- Select Projects, and then select Default Project.
For the pipeline to run successfully, please follow the remaining steps as they are, including the naming conventions.
Delegate
What is the Harness delegate?
The Harness delegate is a service that runs in your local network or VPC to establish connections between the Harness Manager and various providers such as artifacts registries, cloud platforms, etc. The delegate is installed in the target infrastructure, for example, a Kubernetes cluster, and performs operations including deployment and integration. Learn more about the delegate in the Delegate Overview.
- Under Project Setup, select Delegates.
- Select Delegates.
- Select New Delegate.
- Select Docker.For this tutorial, let's explore how to install a delegate using Docker.
- In the command provided,
ACCOUNT_ID
andMANAGER_ENDPOINT
are auto-populated values that you can obtain from the delegate installation wizard. - Replace DELEGATE_TOKEN in the command with the token from the wizard.
docker run -dit --cpus=1 --memory=2g \
-e DELEGATE_NAME=docker-delegate \
-e NEXT_GEN="true" \
-e DELEGATE_TYPE="DOCKER" \
-e ACCOUNT_ID=ACCOUNT_ID \
-e DELEGATE_TOKEN=DELEGATE_TOKEN \
-e LOG_STREAMING_SERVICE_URL=https://app.harness.io/gratis/log-service/ \
-e MANAGER_HOST_AND_PORT=https://app.harness.io/gratis harness/delegate:23.05.79310 - Select Verify to verify that the delegate is installed successfully and can connect to the Harness Manager.
- Select Delegates.
You can also follow the Install Harness Delegate on Kubernetes or Docker tutorial to install the delegate using the Harness Terraform Provider or a Kubernetes manifest.
Secrets
What are Harness secrets?
Harness offers built-in secret management for encrypted storage of sensitive information. Secrets are decrypted when needed, and only the private network-connected Harness delegate has access to the key management system. You can also integrate your own secret manager. To learn more about secrets in Harness, go to Harness Secret Manager Overview.
- Under Project Setup, select Secrets.
- Select New Secret, and then select Text.
- Enter the secret name
harness_gitpat
. - For the secret value, paste the GitHub personal access token you saved earlier.
- Select Save.
- Under Project Setup, select Secrets.
- Select New Secret, and then select File.
- Enter the secret name
gcp
. - For the secret value, upload the Google Cloud's account service key file for your service account, which you can download from your GCP project.
- Select Save.
Connectors
What are connectors?
Connectors in Harness enable integration with 3rd party tools, providing authentication and operations during pipeline runtime. For instance, a GitHub connector facilitates authentication and fetching files from a GitHub repository within pipeline stages. For more details, go to Connectors.
- Create the GitHub connector.
- Copy the contents of github-connector.yml.
- In your Harness project in the Harness Manager, under Project Setup, select Connectors.
- Select Create via YAML Builder and paste the copied YAML.
- Assuming you have already forked the harnessed-example-apps repository mentioned earlier, replace
GITHUB_USERNAME
with your GitHub account username in the YAML. - In
projectIdentifier
, verify that the project identifier is correct. You can see the Id in the browser URL (afteraccount
). If it is incorrect, the Harness YAML editor will suggest the correct Id. - Select Save Changes and verify that the new connector named harness_gitconnector is successfully created.
- Finally, select Connection Test under Connectivity Status to ensure the connection is successful.
- Create the GCP connector.
- Copy the contents of gcp-connector.yml.
- In your Harness project, under Project Setup, select Connectors.
- Select Create via YAML Builder and and paste the copied YAML.
- Select Save Changes and verify that the new connector named gcpconnector is successfully created.
- Finally, select Connection Test under Connectivity Status to verify the connection is successful.
Environment
What are Harness environments?
Environments define the deployment location, categorized as Production or Pre-Production. Each environment includes infrastructure definitions for serverless functions, VMs, Kubernetes clusters, or other target infrastructures. To learn more about environments, go to Environments overview.
- In your Harness project, select Environments.
- Select New Environment, and then select YAML.
- Copy the contents of environment.yml, paste it into the YAML editor, and select Save.
- In your new environment, select the Infrastructure Definitions tab.
- Select Infrastructure Definition, and then select YAML.
- Copy the contents of infrastructure-definition.yml and paste it into the YAML editor.
- Replace
GCP PROJECT NAME
with your GCP project name. - Replace
GCP REGION
with your GCP region name. - Select Save and verify that the environment and infrastructure definition are created successfully.
Services
What are Harness services?
In Harness, services represent what you deploy to environments. You use services to configure variables, manifests, functions, and artifacts. The Services dashboard provides service statistics like deployment frequency and failure rate. To learn more about services, go to Services overview.
- In your Harness project, select Services.
- Select New Service.
- Enter the name
hello_http
. - Select Save, and then YAML (on the Configuration tab).
- Select Edit YAML, copy the contents of service.yml, and paste the into the YAML editor.
- Replace
GCP PROJECT
with your GCP project name. - Replace
GCP BUCKET
with your GCP bucket name. - Select Save, and verify that the service hello_http is successfully created.
Pipeline
What are Harness pipelines?
A pipeline is a comprehensive process encompassing integration, delivery, operations, testing, deployment, and monitoring. It can utilize CI for code building and testing, followed by CD for artifact/function deployment in production. A CD Pipeline is a series of stages where each stage deploys a service to an environment. To learn more about CD pipeline basics, go to CD pipeline basics.
- In your Harness project, select Pipelines.
- Select Create a Pipeline.
- Enter the name
hello_http
. - Select Inline to store the pipeline in Harness.
- Select Start.
- In Pipeline Studio, select YAML.
- Select Edit YAML and choose any of the following execution strategies. Paste the respective YAML based on your selection.
- Canary
- Blue Green
- Basic
What are Canary deployments?
A canary deployment updates nodes/functions/etc. in a single environment gradually, allowing you to use gates between increments and shift traffic as needed. Canary deployments allow incremental updates and ensure a controlled rollout process. For more information, go to When to use Canary deployments.
- Copy the contents of canary-pipeline.yml.
- In your Harness pipeline YAML editor, paste the YAML.
- Select Save. You can switch to the Visual editor and confirm the pipeline stage and execution steps as shown below.
![Click to view full size image](/assets/images/canary-gen2-e73adec55653dc48ea4c4784e06737bf.png)
What are Blue Green deployments?
Blue Green deployments involve running two identical environments (stage and prod) simultaneously with different service versions. QA and UAT are performed on a new service version in the stage environment first. Next, traffic is shifted from the prod environment to stage, and the previous service/function version running on prod is scaled down. Blue Green deployments are also referred to as red/black deployment by some vendors. For more information, go to When to use Blue Green deployments.
Copy the contents of bluegreen-pipeline.yml.
In your Harness pipeline YAML editor, paste the YAML.
Select Save.
You can switch to the Visual pipeline editor and confirm the pipeline stage and execution steps as shown below.
![Click to view full size image](/assets/images/bluegreen-gen2-7dde02c168bb387040f7d7965bcc125f.png)
What are Basic deployments?
For Google Cloud Functions, the basic deployment execution strategy deploys the new function version and routes 100% of traffic from the old version to the new function version.
Copy the contents of basic-pipeline.yml.
In your Harness pipeline YAML editor, paste the YAML.
Select Save.
You can switch to the Visual pipeline editor and confirm the pipeline stage and execution steps as shown below.
Finally, it's time to execute your pipeline.
- Select Run, and then select Run Pipeline to initiate the deployment.
- Observe the execution logs as Harness deploys the function.
- After a successful execution, you can check the deployment on your Google Cloud Function console.
Congratulations!🎉
You've just learned how to use Harness CD to deploy a Google Cloud Function to Google Cloud.
What's next?
- Keep learning about Harness CD. For example, add Triggers to your pipeline that initiate pipeline deployments in response to Git events.
- Visit the Harness Developer Hub for more tutorials and resources.
Getting Started with Harness CD
- Log into Harness.
- Select Projects, and then select Default Project
For the pipeline to run successfully, please follow the remaining steps as they are, including the naming conventions.
Delegate
What is the Harness delegate?
The Harness delegate is a service that runs in your local network or VPC to establish connections between the Harness Manager and various providers such as artifacts registries, cloud platforms, etc. The delegate is installed in the target infrastructure, for example, a Kubernetes cluster, and performs operations including deployment and integration. Learn more about the delegate in the Delegate Overview.
Under Project Setup, select Delegates.
Select Delegates.
Select New Delegate.
For this tutorial, let's explore how to install a delegate using Docker.
In the command provided,
ACCOUNT_ID
andMANAGER_ENDPOINT
are auto-populated values that you can obtain from the delegate installation wizard.Replace DELEGATE_TOKEN in the command with the token from the wizard.
docker run -dit --cpus=1 --memory=2g \
-e DELEGATE_NAME=docker-delegate \
-e NEXT_GEN="true" \
-e DELEGATE_TYPE="DOCKER" \
-e ACCOUNT_ID=ACCOUNT_ID \
-e DELEGATE_TOKEN=DELEGATE_TOKEN \
-e LOG_STREAMING_SERVICE_URL=MANAGER_ENDPOINT/log-service/ \
-e MANAGER_HOST_AND_PORT=MANAGER_ENDPOINT harness/delegate:23.05.79310Select Verify to verify that the delegate is installed successfully and can connect to the Harness Manager.
Select Verify to verify that the delegate is installed successfully and can connect to the Harness Manager.
You can also follow the Install Harness Delegate on Kubernetes or Docker tutorial to install the delegate using the Harness Terraform Provider or a Kubernetes manifest.
Secrets
What are Harness secrets?
Harness offers built-in secret management for encrypted storage of sensitive information. Secrets are decrypted when needed, and only the private network-connected Harness delegate has access to the key management system. You can also integrate your own secret manager. To learn more about secrets in Harness, go to Harness Secret Manager Overview.
- Under Project Setup, select Secrets.
- Select New Secret, and then select Text.
- Enter the secret name
harness_gitpat
. - For the secret value, paste the GitHub personal access token you saved earlier.
- Select Save.
- Under Project Setup, select Secrets.
- Select New Secret, and then select File.
- Enter the secret name
gcp
. - For the secret value, upload the Google Cloud's account service key file for your service account, which you can download from your GCP project.
- Select Save.
Connectors
What are connectors?
Connectors in Harness enable integration with 3rd party tools, providing authentication and operations during pipeline runtime. For instance, a GitHub connector facilitates authentication and fetching files from a GitHub repository within pipeline stages. Explore connector how-tos here.
- Create the GitHub connector.
- Copy the contents of github-connector.yml
- In your Harness project in the Harness Manager, under Project Setup, select Connectors.
- Select Create via YAML Builder and paste the copied YAML.
- Assuming you have already forked the harnessed-example-apps repository mentioned earlier, replace GITHUB_USERNAME with your GitHub account username in the YAML.
- In
projectIdentifier
, verify that the project identifier is correct. You can see the Id in the browser URL (afteraccount
). If it is incorrect, the Harness YAML editor will suggest the correct Id. - Select Save Changes and verify that the new connector named harness_gitconnector is successfully created.
- Finally, select Connection Test under Connectivity Status to ensure the connection is successful.
- Create the GCP connector.
- Copy the contents of gcp-connector.yml.
- In your Harness project, under Project Setup, select Connectors.
- Select Create via YAML Builder and and paste the copied YAML.
- Select Save Changes and verify that the new connector named gcpconnector is successfully created.
- Finally, select Connection Test under Connectivity Status to verify the connection is successful.
Environment
What are Harness environments?
Environments define the deployment location, categorized as Production or Pre-Production. Each environment includes infrastructure definitions for serverless functions, VMs, Kubernetes clusters, or other target infrastructures. To learn more about environments, go to Environments overview.
- In your Harness project, select Environments.
- Select New Environment, and then select YAML.
- Copy the contents of environment.yml, paste it into the YAML editor, and select Save.
- In your new environment, select the Infrastructure Definitions tab.
- Select Infrastructure Definition, and then select YAML.
- Copy the contents of infrastructure-definition.yml and paste it into the YAML editor.
- Replace
GCP PROJECT NAME
with your GCP project name. - Replace
GCP REGION
with your GCP region name. - Select Save and verify that the environment and infrastructure definition are created successfully.
Services
What are Harness services?
In Harness, services represent what you deploy to environments. You use services to configure variables, manifests, functions, and artifacts. The Services dashboard provides service statistics like deployment frequency and failure rate. To learn more about services, go to Services overview.
- In your Harness project, select Services.
- Select New Service.
- Enter the name
hello_world
. - Select Save, and then YAML (on the Configuration tab).
- Select Edit YAML, copy the contents of service.yml, and paste the into the YAML editor.
- Replace
GCP PROJECT
with your GCP project name. - Replace
GCP BUCKET
with your GCP bucket name. - Select Save, and verify that the service hello_world is successfully created.
Pipeline
What are Harness pipelines?
A pipeline is a comprehensive process encompassing integration, delivery, operations, testing, deployment, and monitoring. It can utilize CI for code building and testing, followed by CD for artifact/function deployment in production. A CD Pipeline is a series of stages where each stage deploys a service to an environment. To learn more about CD pipeline basics, go to CD pipeline basics.
- In your Harness project, select Pipelines.
- Select Create a Pipeline.
- Enter the name
hello_world
. - Select Inline to store the pipeline in Harness.
- Select Start.
- In Pipeline Studio, select YAML.
- Select Edit YAML and Paste the below Rolling deployment YAML.
What are Basic deployments?
For Google Cloud Functions, the basic deployment execution strategy deploys the new function version and routes 100% of traffic from the old version to the new function version.
Copy the contents of basic-pipeline.yml.
In your Harness pipeline YAML editor, paste the YAML.
Select Save.
You can switch to the Visual pipeline editor and confirm the pipeline stage and execution steps as shown below.
![Click to view full size image](/assets/images/rolling_gen1-c96602995497040e499cd15e15aa548a.png)
Finally, it's time to execute your pipeline.
- Select Run, and then select Run Pipeline to initiate the deployment.
- Observe the execution logs as Harness deploys the workload and checks for steady state.
- After a successful execution, you can check the deployment on your Google Cloud Function console.
Congratulations!🎉
You've just learned how to use Harness CD to deploy an application using a Google Cloud Functions gen 1 to Google Cloud.
What's Next?
- Keep learning about Harness GitOps. Create a GitOps ApplicationSet and PR Pipeline in Harness GitOps by following this guide.
- Visit the Harness Developer Hub for more tutorials and resources.