https://github.com/scality/osis
https://github.com/scality/osis
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/scality/osis
- Owner: scality
- License: apache-2.0
- Created: 2020-11-17T19:42:44.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T09:45:36.000Z (almost 2 years ago)
- Last Synced: 2025-10-23T02:45:39.348Z (8 months ago)
- Language: Java
- Size: 3.63 MB
- Stars: 3
- Watchers: 29
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# vmware-ose-scality
## Abstract
VMware Cloud Director Object Storage Extension (for short, OSE) is a standalone middleware service installed in a private data center or public cloud to provide object storage capabilities to VMware Cloud Director users.
OSIS (Object Storage Interoperability Service) is proposed to extend OSE to support other object storage platforms by defining unified administrative interfaces for storage platforms.
For the platforms integrated with OSE via OSIS, the data channel is between OSE and the platform, but the control channel is between OSE and the OSIS implementation (REST services implementing OSIS).
This project is for OSIS, which integrates [Scality RING](https://www.scality.com/products/ring/) with vCloud Director OSE.
## Running the Application
### Commands to Run Docker Image
1. Docker images can be built locally or pulled locally from either dev namespace using the hash or production namespace.
Local build:
```sh
$ docker build -t .
```
Dev:
```sh
docker pull ghcr.io/scality/osis:
```
Production image:
```sh
docker pull ghcr.io/scality/osis:
```
1. Generate a self-signed SSL certificate and store it in a binary PKCS#12 format file with extension `.p12` file. (Refer [here](#To-generate-PKCS12-file-for-self-signed-SSL-certificate))
1. Create an `application.properties` environment variables file.
- A sample `application.properties` file can be found [here](src/main/resources/application.properties).
- Update `server.ssl.key-store-password` and `server.ssl.key-alias` with the `.p12` file's key-store password and key-store alias, respectively.
1. Create an `crypto.yml` environment variables file.
- A sample `crypto.yml` file can be found [here](src/main/resources/crypto.yml).
- Update `osis.security.keys.cipher` with a 32 byte password
1. To run the Docker image locally using a local build image, or from either the dev namespace (using the hash) or the production namespace (with the `application.properties` environment file):
Local build image:
```sh
$ docker run \
-it \
-p 8443:8443 \
-v :/app/lib/osis.p12:ro,z \
-v :/conf/crypto.yml:ro,z \
-v :/conf/application.properties:ro,z \
```
dev:
```sh
$ docker run \
--env-file application.properties \
-it \
-p 8443:8443 \
-v :/app/lib/osis.p12:ro,z \
-v :/conf/crypto.yml:ro,z \
-v :/conf/application.properties:ro,z \
ghcr.io/scality/osis:
```
Production image:
```sh
$ docker run \
--env-file application.properties \
-it \
-p 8443:8443 \
-v :/app/lib/osis.p12:ro,z \
-v :/conf/crypto.yml:ro,z \
-v :/conf/application.properties:ro,z \
ghcr.io/scality/osis:
```
#### To generate a PKCS12 file for a self-signed SSL certificate
**Generate a `.p12` format file with self-signed SSL certificate using Keytool.**
```shell
keytool \
-genkeypair \
-keyalg RSA \
-alias \
-keystore .p12 \
-storepass \
-validity \
-keysize \
-dname "CN=, OU=, O=, L=, ST=, C=" \
-storetype pkcs12
```
**Example:**
```shell
keytool \
-genkeypair \
-keyalg RSA \
-alias osis.dev.eng.scality.com \
-keystore keyStore.p12 \
-storepass scality \
-validity 3650 \
-keysize 2048 \
-dname "CN=scality-osis-app, OU=Scality, O=Scality, L=SanFrancisco, ST=California, C=US" -storetype pkcs12
```
#### To view Tomcat access logs in the Docker container
* Run `docker exec -it /bin/bash`
* Access log files can be found under `/tomcat/logs`
### Run the Application as a Standalone Jar (Developers Only)
1. `./gradlew clean build`
2. `./gradlew bootJar`
3. `java -jar -Dserver.tomcat.basedir=tomcat -Dserver.tomcat.accesslog.directory=logs -Dserver.tomcat.accesslog.enabled=true build/libs/osis-scality-[CURRENT_VERSION].jar`
### Scan for vulnerabilities
- `./gradlew dependencyCheckAnalyze`: Runs dependency-check against the project and generates a report under `build/reports`
- `./gradlew dependencyCheckUpdate`: Updates the local cache of the NVD data from NIST.
- `./gradlew dependencyCheckPurge`: Deletes the local copy of the NVD. This is used to force a refresh of the data.
- More configuration options:
## Verify the Implementation (Developers Only)
Install and run [vmware-ose-osis-verifier](https://github.com/vmware-samples/object-storage-extension-samples/tree/master/vmware-ose-osis-verifier) for each API.