Skip to main content

🚀 Deploy Your First Cloud Function in 5 Minutes

Want to see Cloudhopper in action? This guide walks you through generating, deploying, and testing a serverless function on your favorite cloud — in just five minutes.

📋 Prerequisites​

You’ll need:

Step 1: Generate a Project​

mvn archetype:generate \
  -DarchetypeGroupId=eu.cloudhopper.mc \
  -DarchetypeArtifactId=cloudhopper-maven-archetype-core \
  -DarchetypeVersion=1.0-SNAPSHOT \
  -DgroupId=com.example \
  -DartifactId=my-function \
  -Dversion=1.0-SNAPSHOT \
  -Dpackage=com.example.fn \
  -DgeneratorIds=aws-terraform,gcp-terraform,azure-terraform,springboot \
  -DincludeTerraformProfile=true \
  -B

Change the list of generatorIds if targeting a different provider.

Step 2: Configure Terraform deployment (for deploy-with-terraform profile)​

The generated project contains terraform files that allow you to set variables required for deployment and add additional variables and resources. You will need to configure these only if you're planning to use the terraform deployment profile.

If you want to copy the generated resources to your own deployment pipeline, you can skip this step. :

src/main/resources/deployment/aws-terraform/main.tf

You need to provide your AWS region and adjust authentication details or terraform backend configuration:

AWS​

provider "aws" {
  region = "us-east-1"
}

Azure​

GCP​

For more advanced setups (IAM roles, VPC config), see Terraform AWS Provider Docs.

Step 3: Build and Generate Deployment Artifacts​

cd my-function
mvn clean install -Paws-terraform

This compiles your function, processes annotations, and generates Terraform files in:

target/deployment/aws-terraform/

You can now copy the generated files along with the generated artefact and deploy the resources as part of your existing pipeline. If you would like to use the deploy-with-terraform profile, proceed wit hthe next step.

Step 4: Deploy the Function with deploy-with-terraform profile​

For the three cloud provider profiles you need to configure the terraform executable.

Make sure your pom.xml includes the path to Terraform:

<properties>
  <terraform.executable>terraform</terraform.executable>
  <path.extras></path.extras>
</properties>

Use the built-in Maven profile to apply the Terraform plan:

mvn verify -Pdeploy-with-terraform -Dterraform.command=apply

Terraform will create the function and related infrastructure.

🔍 Step 5: Test Your Function​

Find the deployed URL in Terraform output or your cloud console, then test it:

curl https://your-function-url/hello

Expected response:

"Hello from Cloudhopper!"

🧭 What’s Next?​