petstore-component-java

Petstore Java component template for the elastic.io platform

This is a component template which we commonly refer as the first step of the development for creating a component to deploy into our platform. This component comes with a basic architecture which can be used on our platform. You can clone it and use it. However, if you plan to deploy it into elastic.io platform you must follow sets of instructions to succeed.

Before you Begin

Before you can deploy any code into our system you must be a registered elastic.io platform user. Please see our home page at https://www.elastic.io to learn how.

Any attempt to deploy a code into our platform without a registration would be rejected.

After the registration and opening of the account you must upload your SSH Key into our platform.

If you fail to upload you SSH Key you will get permission denied error during the deployment.

Getting Started

After registration and uploading of your SSH Key you can proceed to deploy it into our system. At this stage we suggest you to:

• Create a team to work on your new component. This is not required but will be automatically created using random naming by our system so we suggest you name your team accordingly.
• Create a repository where your new component is going to reside inside the team that you have just created.

$ git clone https://github.com/elasticio/petstore-component-java.git your-repository

$ cd your-repository

Now you can edit your version of petstore-component-java component and build your desired component. Or you can just PUSHit into our system to see the process in action:

$ git remote add elasticio your-team@git.elastic.io:your-repository.git

$ git push elasticio master

Obviously the naming of your team and repository is entirely up-to you and if you do not put any corresponding naming our system will auto generate it for you but the naming might not entirely correspond to your project requirements.

File Structure

The structure of petstore-component-java component is quite flexible. elastic.io platform expects only two files to be present in the main directory. These are the component.json and package.json. Our documentation on how to build a component in Java has more about each file and their function.