Configuring VMware Cloud Director Object Storage Extension with an ECS cluster consists of establishing a connection between VMware Cloud Director Object Storage Extension and ECS services.

For security purposes, VMware Cloud Director Object Storage Extension validates the complexity of all passwords. When you set passwords by using the ose command-line utility, make sure that the password contains:
  • At least eight characters
  • Minimum one uppercase character
  • Minimum one lowercase character
  • Minimum one numeric digit character
  • Minimum one non-alphanumeric character.

    Use only visible ASCII characters. Do not use space and non-printing control characters, such as BEL or NUL.

VMware Cloud Director Object Storage Extension performs a password validation as part of the execution of the following scripts:
  • ose ecs admin set
  • ose ecs console set
For testing purposes, you can avoid the password validation by adding the --force argument to the command that you run.

Prerequisites

Verify that your ECS configuration meets the deployment requirements of VMware Cloud Director Object Storage Extension. See ECS Deployment Requirements.

Procedure

  1. Open an SSH connection to the machine on which you installed VMware Cloud Director Object Storage Extension.
  2. Start the VMware Cloud Director Object Storage Extension Keeper service.
    systemctl start voss-keeper
  3. Configure the connection to the ECS Admin Service HTTPS API endpoint.
    ose ecs admin set --url ecs-admin-service-url --user admin-user --secret 'password'

    If the password that you enter contains a single quote character ('), run the command without the --secret argument and the system prompts you to enter the password on a new line.

    For example:
    ose ecs admin set --url https://object-storage.acme.com:19443 --user sysadmin --secret 'ChangeIt!'
  4. Configure the connection to the ECS Management Console.
    ose ecs console set --url ecs-console-url --user admin-user --secret admin-user-pass
    For example:
    ose ecs console set --url https://object-storage.acme.com:8443 --user admin --secret ChangeIt!
  5. Configure the connection to the ECS S3 Service.
    ose ecs s3 set ecs-s3-url

    To configure the connection, use the FQDN or the IP address of the S3 Service. If you use the FQDN, make sure that you correctly configure the S3 Service domain in the ECS cluster. Also, make sure that your DNS server can route all bucket requests from the virtual to the actual S3 Service host. For example, from bucket-name.ecs-s3-host to ecs-s3-host. If you use the IP address of the S3 Service, no domain and virtual host route settings are required.

    For example:
    ose ecs s3 set https://object-storage.acme.com:443
  6. Validate the configuration.
    ose config validate
    If all components are successfully configured, the system returns the following message:
    +------------------------+-------------+-----------------+---------------------------------+
    |          Name          |   Required  |   Connectivity  |            Detail               |
    +========================+=============+=================+=================================+
    |        Database        |      Y      |      Normal     |                                 |
    +------------------------+-------------+-----------------+---------------------------------+
    |       Certificate      |      Y      |      Normal     |                                 |
    +------------------------+-------------+-----------------+---------------------------------+
    |     Cloud Director     |      Y      |      Normal     |                                 |
    +------------------------+-------------+-----------------+---------------------------------+
    |     Platform - ECS     |      Y      |      Normal     |                                 |
    +------------------------+-------------+-----------------+---------------------------------+
    |    ECS Admin Service   |      Y      |      Normal     |                                 |
    +------------------------+-------------+-----------------+---------------------------------+
    |   ECS Console Service  |      N      |      Normal     |                                 |
    +------------------------+-------------+-----------------+---------------------------------+
    |     ECS S3 Service     |      Y      |      Normal     |                                 |
    +------------------------+-------------+-----------------+---------------------------------+
    
    If the system returns an error, review the log file at /opt/vmware/voss/log.
  7. Verify the status of the VMware Cloud Director Object Storage Extension service.
    ose service show
    If the VMware Cloud Director Object Storage Extension service runs as expected, the system returns a Running status and configuration details.

    If you receive an error message, you can start the VMware Cloud Director Object Storage Extension service in debugging mode by adding the --debug argument and troubleshoot the problem.

  8. Start VMware Cloud Director Object Storage Extension services.
    ose service start
  9. (Optional) Get configuration details.
    ose ecs show
    The system returns the ECS configuration details in the following format:
    [ECS Admin]
        URL: https://object-storage.acme.com:19443
        username: sysadmin
    [ECS Console]
        URL: https://object-storage.acme.com:8443
        username: admin
    [ECS S3]
        URL: https://object-storage.acme.com:443