Skip to main content

Getting started

A 5 minutes intro on how to create and account and start a sample generator as a spring boot application.

Sign-up​

Sign-in using your identity. In case of an enterprise environment your global administrators might need to approve you to hand over some details to us which comes down just to the email that is used as a single identifier and a notification target.

At this moment we support any Microsoft identity. In case of need you may create one here: https://signup.live.com/

Create an account​

Chose your account name. It needs to be globally unique.

You will be redirected to the account settings page where you can get:

  • The Sixpack API url
  • Your certificate
  • Your private key
  • Your authorisation token

The private key is used for mTLS. The authorisation token is used getting access to your namespace within the Sixpack orchestration platform. Both are to be treated as secrets.

Start a sample generator​

Clone our sample for spring boot

git clone https://github.com/sixpack-dev/sixpack-sample-java-spring.git

  • Download the Private key and Certificate via download buttons on the account settings page. The files will be named generator.pkey.pem and generator.cert.pem respectively. You may rename them as you wish.

  • Copy the authorisation token from the account settings page.

  • Place the files in the folder /certs/ under the cloned repository

  • Open the repository in an IDE

  • In the file MySypplier.java, adapt configuration attributes: account name, authorisation token and Sixpack URL.

Note: the authorisation token is not to be committed to any git repository. A more secure way is to place it in an environment variable. For that remove the line .withAuthToken and configure the environment variable SIXPACK_AUTH_TOKEN. You can configure all other settings in the same way.

  • If necessary, configure the JDK to be used (should be above 17), and other typical java initial configurations for any imported java project

  • Run the spring boot application called MyApp

  • Your data generator now should be successfully connected to the Sixpack platform and already pre-generate some datasets

Play around​

You can play around, try to request some data and see how it works and read further here...