Official Installation Documentation = Install VMware Cloud Director Object Storage Extension
1. Install PostgreSQL
sudo apt install postgresql postgresql-contrib -y
2. Verify that you've installed PostgreSQL
psql --version
psql --version
psql (PostgreSQL) 14.11 (Ubuntu 14.11-0ubuntu0.22.04.1)
3. By default only connections from the local system are allowed, to enable all other computers to connect to your PostgreSQL server, edit the file /etc/postgresql/*/main/postgresql.conf
. Locate the line: #listen_addresses = 'localhost'
and change it to *
:
listen_addresses = '*'
4. Edit /etc/postgresql/14/main/pg_hba.conf
+ Add host all all 0.0.0.0/0 md5
sudo vim /etc/postgresql/14/main/pg_hba.conf
# Database administrative login by Unix domain socket
local all postgres peer
# TYPE DATABASE USER ADDRESS METHOD
# "local" is for Unix domain socket connections only
local all all peer
# IPv4 local connections:
host all all 0.0.0.0/0 md5
#host all all 127.0.0.1/32 scram-sha-256
# IPv6 local connections:
host all all ::1/128 scram-sha-256
# Allow replication connections from localhost, by a user with the
# replication privilege.
local replication all peer
host replication all 127.0.0.1/32 scram-sha-256
5. Access the psql
CLI via:
sudo -u postgres psql
6. Create OSE Database And User
postgres=# create user oseadmin with password 'PASSWORD';
CREATE ROLE
postgres=# create database osedb owner oseadmin;
CREATE DATABASE
postgres=# grant all privileges on database osedb to oseadmin;
GRANT
\quit
7. Restart postgresql
sudo systemctl restart postgresql
8. Install Java OpenJDK 17:
sudo apt install openjdk-17-jdk -y
9. Verify Java version:
java --version
java --version
openjdk 17.0.10 2024-01-16
OpenJDK Runtime Environment (build 17.0.10+7-Ubuntu-122.04.1)
OpenJDK 64-Bit Server VM (build 17.0.10+7-Ubuntu-122.04.1, mixed mode, sharing)
10. Download the VMware Cloud Director Object Storage Extension (Current GA Version = 3.0
)
sudo apt-get install $HOME/vmware-ose-3.0.0-23443325.deb -y
11. Optional: In order to prevent invoking sudo
at the CLI each time you want to execute the ose
command, you can Ubuntu's username into the vmware-voss
group via the following command (exiting the shell is required for the changes to take effect):
sudo usermod -aG vmware-voss USER
12. Accept the EULA by invoking sudo ose
from the CLI and input accept
:
? Do you accept the EULA to continue configuring the software? (input 'accept'): accept
NAME:
ose - VMware Cloud Director Object Storage Extension
(OSE) middleware Command-line tool
USAGE:
ose <subcommand> [flags]
VERSION:
'3.0.0-23443325'
COMMANDS:
amazon Set and show amazon configuration
args Set / get / del / show current configuration
cert Import / gen / show OSE service SSL certificate
cloudian Set and show Cloudian configuration
config Validate / import / export OSE configuration
db Set and show database connection
director Set and show Cloud Director connection
ecs Set and show ECS configuration
endpoint Set OSE endpoint URL configuration
help Help about any command
jvmargs Set / del / show current java options argument configuration
migration Migrate data to version['3.0.0-23443325']
osis Set OSIS compliant platform endpoint
platforms Set and show storage platform
service Start / stop / restart / show OSE middleware
show Show all configurations in OSE
support Collect ose configuration and logs to help vmware ose team troubleshoot
ui Install / uninstall / show OSE UI plugin
OPTIONS:
-h, --help help for ose
--host="127.0.0.1" the host of OSE keeper service
--port=5198 the port of OSE keeper service
--version version for ose
13. Refer to Installing and Configuring VMware Cloud Director Object Storage Extension for any additional information.
14. Configure the OSE endpoint and region (Prompt Method):
ose endpoint set
15. Configure a self-signed certificate (Replace certificate-password
)
ose cert gen --cn vose.philbendeck.com --secret certificate-password
16. Configure the database connection (Replace 'PASSWORD'
):
ose db set --url jdbc:postgresql://127.0.0.1:5432/osedb --user 'oseadmin' --secret 'PASSWORD'
17. Configure the connection to VMware Cloud Director:
Prompt Method:
ose director set
Syntax Method:
ose director set --url https://vcd.philbendeck.com --user administrator@system --secret 'PASSWORD'
18. Install the VMware Cloud Director Object Storage Extension user interface plug-in.
Prompt Method
ose ui install
Syntax Method
ose ui install --ose-url https://vose.philbendeck.com:443
19. Refer to Configure VMware Cloud Director Object Storage Extension with Cloudian HyperStore
7.4.(x)
or 7.5.(x)
20. Start the VMware Cloud Director Object Storage Extension Keeper service (the installation should start the service automatically via systemd
).
systemctl start voss-keeper
21. Configure the connection to the Cloudian HyperStore Admin
Service HTTPS API endpoint:
To retrieve the Admin
API password from the Cloudian HyperStore Cluster:
hsctl config get admin.auth.password
Prompt Method
ose cloudian admin set
Syntax Method
ose cloudian admin set --url https://s3-admin.philbendeck.com:19443 --user sysadmin --secret 'ADMIN-API PASSWORD'
22. Configure the connection to the Cloudian HyperStore S3
Service:
Prompt Method
ose cloudian s3 set
Syntax Method
ose cloudian s3 set https://s3-vcd.philbendeck.com
23. Configure the connection to the Cloudian HyperStore IAM
Service:
Prompt Method
ose cloudian iam set
Syntax Method
ose cloudian iam set https://iam.philbendeck.com:16443
24. Configure the connection to the Cloudian Management Console (CMC
):
cmc_sso_enabled,true
./etc/cloudian-VER-puppet/manifests/extdata/common.csv
cmc_sso_shared_key
Retrieve password via (Replace VER
with the version of HyperStore):
grep cmc_sso_shared_key, /etc/cloudian-VER-puppet/manifests/extdata/common.csv
Prompt Method
ose cloudian console set
Syntax Method
ose cloudian console set --url https://cmc.philbendeck.com:8443 --user admin --secret SECRET force
25. Enable the use of the Cloudian HyperStore platform.
ose platforms enable cloudian
26. Ensure and verify that all the connectivity to each services is in a Valid
state:
ose config validate
+------------------------------------+-------------+---------------+-----------+
| Name | Required | Validation | Detail |
+====================================+=============+===============+===========+
| Region validation for vcd | Y | Valid | |
+------------------------------------+-------------+---------------+-----------+
| Database | Y | Valid | |
+------------------------------------+-------------+---------------+-----------+
| Certificate | Y | Valid | |
+------------------------------------+-------------+---------------+-----------+
| Cloud Director | Y | Valid | |
+------------------------------------+-------------+---------------+-----------+
| Platform - Cloudian | Y | Valid | |
+------------------------------------+-------------+---------------+-----------+
| Cloudian Administration Service | Y | Valid | |
+------------------------------------+-------------+---------------+-----------+
| Cloudian S3 Service | Y | Valid | |
+------------------------------------+-------------+---------------+-----------+
| Cloudian IAM Service | Y | Valid | |
+------------------------------------+-------------+---------------+-----------+