psm MySQLCS create-service

Create an Oracle MySQL Cloud Service instance.

Syntax

In the following syntax, line breaks have been added for clarity. Do not include them when entering the command.

psm MySQLCS create-service -c|--config-payload path-to-json-file 
    [-of|--output-format json|html|short]

Parameters

Parameter Description

-c|--config-payload path-to-json-file

Specifies the path to a JSON file containing the instance-creation information necessary to create an Oracle MySQL Cloud Service instance. The format of this file is the same as the request body you provide when creating an instance using the REST API. .

-of|--output-format json|html|short

(Optional) Specifies the output format of the command’s response:

  • json—output is formatted as a JSON array.

  • html—output is formatted as HTML

  • short—output is formatted as a brief summary.

The default output format is the one you specified when using the psm setup command to configure the psm CLI.

JSON Payload

The JSON payload has the following syntax:

{
  "serviceParameters":{
    "serviceName":"nameoftheservice",
    "serviceDescription":"description of the service",
    "serviceVersion":"5.7",
    "vmPublicKeyText":"contents-of-public-ssh-key",
    "serviceLevel":"PAAS",
    "vmUser":"opc",
    "backupDestination":"backup-types",
    "cloudStorageContainer":"name-of-container",
    "cloudStorageUser":"storage-username",
    "cloudStoragePassword":"storage-user-password"
  },
  "componentParameters": {
		"mysql": {
			"shape": "oracle-compute-shape",
			"mysqlUserName": "mysql-server-username",
			"mysqlUserPassword": "mysql-server-user-password",
			"dbName": "name-of-database",
			"dbStorage": "size-of-database-gb",
			"mysqlCharset":"name-of-chacset",
			"mysqlEMPort":"tomcat-listening-port",
			"enterpriseMonitor":"yes-or-no",
			"enterpriseMonitorManagerUser":"admin-username",
			"enterpriseMonitorManagerPassword":"admin-user-password",
			"enterpriseMonitorAgentUser":"agent-username",
			"enterpriseMonitorAgentPassword":"agent-user-password"
    }
  }
}
Parameter Description

serviceName

Name of Oracle MySQL Cloud Service instance.

The service name:

  • Must not exceed 50 characters.

  • Must start with a letter.

  • Must contain only letters, numbers, or hyphens.

  • Must not contain any other special characters.

  • Must be unique within the identity domain.

serviceLevel

Service level. The only currently supported value is:

  • "PAAS"—Production-level service. Supports Oracle MySQL Cloud Service instance creation and monitoring; backup and restoration; patching; and scaling. This is the default.

serviceDescription

Free-form text that provides additional information about the service instance.

serviceVersion

Oracle MySQL Cloud Service version. The only currently supported value is 5.7.

vmPublicKeyText

File that contains the public key for the secure shell (SSH). This key will be used for authentication when connecting to the Oracle MySQL Cloud Service instance using an SSH client.

For example:
"VMsPublicKey" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDOOVKYC3NI6FQd63NTlEGhvGuk7+
H69VCYXLC6JGIhaNQGb0DnEukcDVlONInrY0OFKD1NYFGPwuh+C65mgv3af+fCerUedWZwFKzuo+vNikQ9DO
I7OIpCN3YHgZW43OmK51G2hfmi7QFjyNpJdUkw2GQb+IlP3lVAF4cQ5Pf1LZfn8oJVfDpAlZuIqR5MBDcoi/
dNEO2a6o+Wm5tCOrkTuOLjOFqdWG0ugAsZyz/KwIZL9/ks4AGeM+RrJr8KA6Ck4XlSG62sMD4ph5GZSXQYsvod
JjypC8XnAb6nW5LHEq6KYSooG/UBgzUVW0bsxFQoHO1nGtzZmn0KJd5Gu3rt xperiment"

You generate the SSH key using SSH key-generation tools or by using the SSH key-generation in the Provision New Oracle MySQL Cloud Service wizard.

vmUser

This must be set to opc, the default administration user for the instance.

backupDestination

A string containing the backup configuration for the service instance:

  • BOTH—Configure backups to local storage on the service instance and to an Oracle Storage Cloud container; corresponding to the, Both Cloud Storage and Local Storage backup destination in the Provision New Oracle MySQL Cloud Service wizard.

  • NONE—Configure no backups; that is, the None backup destination.

cloudStorageContainer

A string containing the Oracle Storage Cloud container for backups. This string has the form:

instance-id_domain/container

where instance is the name of the Oracle Storage Cloud Service instance, id_domain is the name of the identity domain, and container is the name of the container.

Include this parameter only if the backupDestination is "BOTH".

cloudStorageUser

The user name of an Oracle Cloud user with read/write access to the specified cloudStorageContainer.

Include this parameter only if the backupDestination is "BOTH".

cloudStoragePassword

A string containing the password of the specified cloudStorageUser.

Include this parameter only if the backupDestination is "BOTH".

cloudStorageContainerAutoGenerate

Whether to create the storage container, or not. This creates the storage container, if an existing container, using the details defined, does not exist. Boolean value, yes or no.

shape

A string containing the Oracle Compute Cloud shape for the service instance:

  • oc3 — 1 OCPU with 7.5 GB RAM

  • oc4 — 2 OCPUs with 15 GB RAM

  • oc5 — 4 OCPUs with 30 GB RAM

  • oc6 — 8 OCPUs with 60 GB RAM

  • oc7 — 16 OCPUs with 120 GB RAM

  • oc1m — 1 OCPU with 15 GB RAM

  • oc2m — 2 OCPUs with 30 GB RAM

  • oc3m — 4 OCPUs with 60 GB RAM

  • oc4m — 8 OCPUs with 120 GB RAM

  • oc5m — 16 OCPUs with 240 GB RAM

mysqlUserName

The MySQL Server user name. The default value is root.

mysqlUserPassword

The MySQL Server user’s password.

dbName

The name of the database to be created in MySQL Server.

mysqlCharset

The character set for MySQL Server. For a full list of supported character sets, see Supported Character Sets.

mysqlEMPort

The port the MySQL Enterprise Monitor’s application server, Apache Tomcat, listens on. By default, this is 18443. By default, an access rule is created for MySQL Enterprise Monitor, called ora_p2admin_em. You must enable this access rule to access MySQL Enterprise Monitor.

Note:

If you define a port other than 18443, you must create a new access rule, and configure it to use the required port. The new access rule must use the same configuration as ora_p2admin_em, but with the new port instead of 18443.

enterpriseMonitor

Defines whether MySQL Enterprise Monitor is provisioned on the Oracle MySQL Cloud Service instance. The following values are possible:

  • No—(Default) MySQL Enterprise Monitor is not provisioned. If these parameters are not defined, No is assumed, and MySQL Enterprise Monitor is not installed.

  • Yes—MySQL Enterprise Monitor is provisioned. If you select this, you must populate the following values.

Note:

Values are case sensitive.

enterpriseMonitorManagerUser

The name of the MySQL Enterprise Monitor’s Manager user. This is the user who configures the installation, adds users, manages the MySQL Enterprise Service Manager, and so on.

enterpriseMonitorManagerPassword

The password for the Manager User.

The password you enter:

  • Must be 8 to 30 characters in length.

  • Must contain at least one lowercase letter

  • Must contain at least one uppercase letter

  • Must contain at least one number

  • Must contain at least one of these symbols: _ (underscore), # (hash sign), or $ (dollar sign).

enterpriseMonitorAgentUser

The name of the Agent user.

Note:

No agent installations are provided at this time. It is currently only possible to install the MySQL Enterprise Service Manager, which can monitor any MySQL instances, local or remote, using a built-in agent.. If you want to monitor MySQL instances installed on other MySQL Cloud Service instances, you can configure the MySQL Service Manager to monitor them, but cannot monitor a remote host’s operating system, file system, or network interfaces. Although agent installations are not currently provided, it is mandatory to define an Agent User and Password to properly configure the MySQL Enterprise Monitor. These parameters can be changed later.

enterpriseMonitorAgentPassword

The password for the Agent User.

The password you enter:

  • Must be 8 to 30 characters in length.

  • Must contain at least one lowercase letter

  • Must contain at least one uppercase letter

  • Must contain at least one number

  • Must contain at least one of these symbols: _ (underscore), # (hash sign), or $ (dollar sign).

Examples

The following example creates a instance as specified by information provided in the create_MySQL57.json file.

$ psm MySQLCS create-service --config-payload create_MySQL57.json
"Accepted"
Job ID : 553993

Note:

You can track the progress of this command using the operation-status command.

The following shows an example of the payload file:

{     
	"serviceName":"MySQL57Service",     
	"serviceDescription":"mysql cloud service payload",     
	"serviceVersion":"5.7",     
	"vmPublicKeyText":"ssh-rsa AAAAB3Nz...",     # key truncated for readability
	"backupDestination":"BOTH",       
	"cloudStorageContainer":"Storage-Storage/MySQLProvisioning",     
	"cloudStorageUser":"StorageUser",     
	"cloudStoragePassword":"PasswordStorage",     
	"componentParameters":{         
		"mysql":{             
			"shape":"oc1m",             
			"mysqlUserName":"root",             
			"mysqlUserPassword":"adminPassword$",
             "dbStorage":"25",
             "dbName":"mydatabase"
			"mysqlCharset":"utf8mb4",
			"mysqlEMPort":"18443",
      	"enterpriseMonitor":"Yes",
      	"enterpriseMonitorManagerUser":"admin",
      	"enterpriseMonitorManagerPassword":"MEMAdm1nPassword#",
      	"enterpriseMonitorAgentUser":"agent",
      	"enterpriseMonitorAgentPassword":"MEMAg3ntPassword#"
         }
     }
 }

The fields listed in the payload correspond to the fields in the Create MySQL Cloud Service Instance page.

Note:

If you do not intend to use a backup destination, specify "backupDestination":“NONE” and do not define the cloud storage parameters.