Cloud Starter
SubscriptionsTo activate MBI for Cloud Starter
projects, first create a MBI account, then create a SSH
key, then finally connect to your Commerce database. See activating on-premise subscriptions.
For help activating MBI for Cloud Pro
projects, contact your Customer Success Manager or Customer Technical Advisor.
Create your MBI Account.
Go to My Account > My MBI Instances.
Click Create Instance. If you do not see this button, contact your Customer Success Manager or Customer Technical Advisor.
Select your Cloud Starter
subscription. If you only have a cloud starter
subscription this will automatically be selected.
Click Continue.
Input your information to create your account.
Input information about your store to set your preferences.
There is some information you need to gather before you can connect your database for the third step in the onboarding flow. You will be filling in the Connect your database
page in Step 9.
Create dedicated MBI User.
Create a new user on https://accounts.magento.com.
Why a new user? MBI needs a user added to the project to continuously fetch new data to be transferred to the account’s MBI data warehouse. This user will serve as that connection. Adding this user to the project will come in Step 4.
The reason for having a dedicated MBI user is to prevent the added user from inadvertently being deactivated or deleted and stopping the MBI connection.
Add the newly created user to the project’s primary environment as a Contributor
.
Get your MBI SSH
keys.
Go to the Connect your database
page of the MBI set up user interface and scroll down to Encryption settings
.
For the Encryption Type
field, choose SSH Tunnel
.
From the dropdown, you can copy and paste the provided MBI Public Key
.
Add your new MBI Public key
to the MBI user created in Step 5.
Go to https://accounts.magento.cloud/. Sign in with your account log in information for the new MBI user created. Then go to the Account Settings
tab.
Scroll down the page and expand the dropdown for SSH
keys. Then click Add a public key.
SSH Public Key
from above.Provide MBI MySQL credentials.
.magento/services.yaml
mysql:
type: mysql:10.0
disk: 2048
configuration:
schemas:
- main
endpoints:
mysql:
default_schema: main
privileges:
main: admin
mbi:
default_schema: main
privileges:
main: ro
.magento.app.yaml
relationships:
database: "mysql:mysql"
mbi: "mysql:mbi"
redis: "redis:redis"
Get information for connecting your database to MBI.
Run
echo $MAGENTO_CLOUD_RELATIONSHIPS | base64 --decode | json_pp
to get information on connecting your database.
You should receive information similar to the output below:
"mbi" : [
{
"scheme" : "mysql",
"rel" : "mbi",
"cluster" : "vfbfui4vmfez6-master-7rqtwti",
"query" : {
"is_master" : true
},
"ip" : "169.254.169.143",
"path" : "main",
"host" : "MBI.internal",
"hostname" : "3m7xizydbomhnulyglx2ku4wpq.mysql.service._.magentosite.cloud",
"username" : "mbi",
"service" : "mysql",
"port" : 3306,
"password" : "[password]"
}
],
Connect your Commerce Database
Integration Name
: [Choose a name for your integration.]
Host
: MBI.internal
Port
: 3306
Username
: mbi
Password
: [input password provided in the output for Step 8.]
Database Name
: main
Table Prefixes
: [leave blank if there are no table prefixes]
Set your Timezone Settings.
Database
: Timezone: UTC
Desired Timezone
: [Choose the time zone you want your data to display in.]
Get information for your encryption settings.
SSH
access string. This string can be used for gathering the information needed for Remote Address
and Username
in setting up your Encryption
settings. Use the SSH Access
string found by clicking the access site button on your Master branch of your Project UI and find your User Name
and Remote Address
as shown below.Input information for your Encryption
settings
Inputs
Encryption Type
: SSH Tunnel
Remote Address
: ssh.us-3.magento.cloud
Username
: vfbfui4vmfez6-master-7rqtwti--mymagento
Port
: 22
Click Save Integration.
You have now successfully connected to your MBI account.
After you have successfully connected MBI to your Commerce database, contact your Customer Success Manager to coordinate the next steps, such as setting up integrations and other configuration steps.
When you finish configuration, you can sign in to your MBI account.