Skip to content
No description, website, or topics provided.
Kotlin JavaScript Java CSS Other
Branch: master
Clone or download
thomasjallerton Merge pull request #6 from thomasjallerton/dependabot/maven/jackson.v…
…ersion-2.10.0.pr1

Bump jackson.version from 2.9.9 to 2.10.0.pr1
Latest commit 6254b92 Aug 4, 2019

README.md

Nimbus is a Java framework that allows for easy deployment and testing of serverless applications.

Installation

Nimbus is made available though maven and is hosted in the maven central repository.

First you need to add the nimbus-core dependency to your pom. This adds the annotation processor and local testing capabilities.

<dependency>
    <groupId>com.nimbusframework</groupId>
    <artifactId>nimbus-core</artifactId>
    <version>0.10</version>
</dependency>

Next the deployment plugin needs to be added. Currently only AWS is supported, so the region parameter needs to be supplied to the plugin configuration.

<plugin>
    <groupId>com.nimbusframework</groupId>
    <artifactId>nimbus-deployment-maven-plugin</artifactId>
    <version>0.6</version>
    <configuration>
        <region>eu-west-1</region>
        <compiledSourcePath>target/generated-sources/annotations/</compiledSourcePath>
    </configuration>
</plugin>

You also need to use the maven shade plugin to package your project into a shaded jar:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-shade-plugin</artifactId>
    <version>3.2.1</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>shade</goal>
            </goals>
            <configuration>
                <outputFile>target/functions.jar</outputFile>
            </configuration>
        </execution>
    </executions>
</plugin>

Here the compiled jar will be placed at target/lambda.jar

Finally, an optional step is to create a nimbus.yml file in the top level of your project. This has only one parameter, projectName, that lets you customise the project name. For example:

projectName: nimbusExample

Caution: projectName needs to be alphanumeric.

Deployment Plugin Configuration Parameters

  • region - The AWS region that this project will be deployed to.

  • stage - The project stage that will be deployed to

  • shadedJarPath - The location where the shaded jar is found. Defaults to target/functions.jar.

  • compiledSourcePath - The location where compiled nimbus files are found. This will be in the compiled annotation sources. Defaults to target/generated-sources/annotations/ (Correct for default java projects, for other languages will likely change)

How to Deploy

To deploy to AWS you need to provide your AWS credentials. This can be done in three ways:

  • Environment variables–AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY. The AWS SDK for Java uses the EnvironmentVariableCredentialsProvider class to load these credentials.

  • Java system properties–aws.accessKeyId and aws.secretKey. The AWS SDK for Java uses the SystemPropertiesCredentialsProvider to load these credentials.

  • The default credential profiles file– typically located at ~/.aws/credentials (location can vary per platform). For example:

[default]
aws_access_key_id = AKIAEXAMPLEKEY
aws_secret_access_key = s8sjhdf/sifys+EXAMPLEACCESSKEY

Then to deploy you need to package your project by running mvn package, and then deploy using mvn nimbus-deployment:deploy

This creates a new stack, and reports any new endpoints.

Sample application

Here we show the deployment of a simple HelloWorld application (assuming correct pom and nimbus.yml files)

public class HelloWorld {
    
    @HttpServerlessFunction(path="helloWorld", method=HttpMethod.GET)
    public String helloWorld() {
        return "Hello World!";
    }
}

Now, we run mvn package.

After this we run mvn nimbus-deployment:deploy. On a successful run we get this output:

[info] Beginning deployment for project: HelloWorld, stage: dev
[info] Creating stack
[info] Polling stack create progress
***************
[info] Stack created
[info] Uploading lambda file
[info] Uploaded file
[info] Uploading cloudformation file
[info] Uploaded file
[info] Updating stack
**********************
[info] Updated stack successfully, deployment complete
[info] Deployment completed
[info] Created REST API. Base URL is https://bq0za24ki8.execute-api.eu-west-1.amazonaws.com/dev
You can’t perform that action at this time.