Prerequisites¶
All the Prerequisites listed below have to be fulfilled before the installation step.
| Context | Prerequisites |
|---|---|
| PIM | Your Akeneo PIM is an enterprise edition |
| Your Akeneo PIM version is >= 2.3.9 and <3.0 | |
| SSO | Your Akeneo PIM instance is accessible through public internet network |
| You’ve communicated the public url to the Akeneo team | |
| Synchronization | You’ve received from the Akeneo team the Onboarder parameters package |
| You are able to launch a daemonized command in your server (a process that needs to be always started) | |
| The HTTP traffic must be allowed on port 443 for the google pubsub api pubsub.googleapis.com | |
| The HTTP traffic must be allowed on port 443 for the google storage api www.googleapis.com |
PIM¶
The Onboarder is compatible with enterprise edition from >= 2.3.9 to <3.0
SSO¶
The Single Sign On process is the only authentication mechanism that is available for the Onboarder. The mechanism will create the user on the fly on the retailer Onboarder application and will ease the user experience between the Akeneo PIM and the retailer Onboarder.
In order to implement the SAMLv2 protocol the Akeneo PIM and the retailer Onboarder must be able to communicate through HTTP calls.
The parameters package provided by the Akeneo team must contain:
- A pair of public and private key needed for signing the communication during the authentication process (pimmaster.crt and pimmaster.pem)
Synchronization¶
Parameters package¶
The parameters package provided by the Akeneo team must contain:
- A
serviceAccount.jsonfile that contains authentication values to be able to use the Google PubSub and Google Cloud Storage services. - Several environments variables values that you will configure in the install process in order to communicate with Google Cloud PubSub instance
ONBOARDER_TOPIC_NAME_FOR_PUBLICATION: the topic where the Akeneo PIM will publish synchronization messagesONBOARDER_TOPIC_NAME_FOR_CONSUMPTION: the topic where the Akeneo PIM will subscribeONBOARDER_QUEUE_NAME: the queue where the Akeneo PIM will consume synchronization messages
ONBOARDER_RETAILER_URL: url of the Onboarder retailer, needed for SSO implementationONBOARDER_CLOUD_STORAGE_BUCKET_NAME: name of the bucket where the assets will be synchronizedONBOARDER_SSO_IDP_PUBLIC_KEY: content of the public key (pimmaster.crt)
Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!