spryker-component

Integration component to talk to Spryker

spryker-component

Spryker Component component for the [elastic.io platform](http://www.elastic.io "elastic.io platform")

If you plan to deploy it into [elastic.io platform](http://www.elastic.io "elastic.io platform") you must follow sets of instructions to succseed.

Before you Begin

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

We'll use git and SSH public key authentication to upload your component code, therefore you must upload your SSH Key.

> 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.

Now as you have a team name and component repository name you can add a new git remote where code shall be pushed to. It is usually displayed on the empty repository page:

$ git remote add elasticio [email protected]:your-repository.git

Obviously the naming of your team and repository is entirely upto 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. Now we are ready to push it:

$ git push elasticio master

Authentication

Authentication is happening via OAuth2.0. In order to make OAuth work you need a new App in your XXX. During app creation process you will be asked to specify the callback URL, to process OAuth auehtncation via elastic.io platform your callback URL should be

https://your-tenant.elastic.io/callback/oauth2

If you are testing it on default public tenant just use https://app.elastic.io/callback/oauth2

Configure OAuth Client key/secret

In the component repository you need to specify OAuth Client credentials as environment variables. You would need two variables

XXX_KEY - your OAuth client key
XXX_SECRET - your OAUth client secret

Known issues

No known issues are there yet.

elasticio / spryker-component Goto Github PK