Skip to content

Commit

Permalink
init stub project
Browse files Browse the repository at this point in the history
  • Loading branch information
wachen committed Aug 17, 2020
1 parent 0e8de1a commit 7efd8ad
Show file tree
Hide file tree
Showing 87 changed files with 5,978 additions and 0 deletions.
2 changes: 2 additions & 0 deletions vmware-ose-osis-stub/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*.class
./out/
77 changes: 77 additions & 0 deletions vmware-ose-osis-stub/CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in [INSERT YOUR PROJECT NAME] project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

35 changes: 35 additions & 0 deletions vmware-ose-osis-stub/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## Contributing to OSIS Implementation

### Developer Certificate of Origin

Before you start working with this project, please read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.

### What should I know before I get started?
Hand on VMware Cloud Director Object Storage Extension; and want to integrate storage platforms with OSE via OSIS.
Have overall picture of [OSE architecture](https://docs.vmware.com/en/VMware-Cloud-Director-Object-Storage-Extension/index.html).
Also know how OSIS unifies storage platforms' administrative interfaces to integrate with OSE.
//TODO OSIS docs

### How Can I Contribute?
- Report/Fix bugs
- Suggest/Implement enhancement
- Add OSIS implementation for other object storage platform

#### Process of code contribution
* Follow the [GitHub process](https://help.github.com/articles/fork-a-repo)
* Please use one branch per change-set
* Please post Cloud Director and Object Storage version, and object storage platform version for new OSIS implementation
* If you include a license with your OSIS implementation, use the project license

### Required Information
Please send a GitHub Pull Request with a clear list of what you've done.
When you send a pull request, it will be great if you include unit tests.
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
```
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
```

### Code Style
[Intellij](https://www.jetbrains.com/idea/) default code style.
37 changes: 37 additions & 0 deletions vmware-ose-osis-stub/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# OSIS Stub Project



## Abstract

VMware Cloud Director Object Storage Extension (for short, OSE) is a standalone middleware service installed in private data center or public cloud to provide object storage capabilities to the users of VMware Cloud Director.
OSE supports three object storage platforms out of box: Cloudian, Dell EMC ECS and Amazon S3.

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 OSIS implementation (REST services implementing OSIS).

This is a stub project for OSIS, which provides the skeleton for developer to start their work.

## Usage
The project has stub and default implementation. Add or modify anything necessary to make it work for new storage platform support.

Module `platform-admin-client` is for platform administrative client.

Module `osis-core` has the project implementation.
- package `com.vmware.osis.model` contains OSIS models
- package `com.vmware.osis.security` contains default implementation of two authentication schema: Basic and API token
- interface `com.vmware.osis.service.OsisService` provides the methods OSIS models manipulation, which should be implemented by `com.vmware.osis.platform.service.impl.PlatformOsisService`
- any required beans can be declared in `com.vmware.osis.platform.configuration.PlatformConfig`
- package `com.vmware.osis.platform.security` contains default implementation for platform specific user data
- class `com.vmware.osis.platform.utils.ModelConverter` should provides the methods to convert OSIS and platform models
- class `com.vmware.osis.platform.AppEnv` holds any application properties
- class `com.vmware.osis.resource.OsisCapsManager` gives default implementation to collect the APIs annotated with `@NotImplemented`

Module `osis-app` has the REST interfaces of OSIS services
class `com.vmware.osis.resource.OsisController` has default implementation of the OSIS REST controller

## Reference
Please also refer the OSIS development guide to get more information about how to implement OSIS services for the object storage platform.


98 changes: 98 additions & 0 deletions vmware-ose-osis-stub/build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
buildscript {
ext {
springBootVersion = '2.2.4.RELEASE'
}
repositories {
mavenCentral()
}
dependencies {
classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
}
}

allprojects {
repositories {
mavenLocal()
mavenCentral()
jcenter()
maven {
url = 'http://repo.maven.apache.org/maven2'
}
}
}

apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'
apply plugin: 'java'
apply plugin: 'idea'

bootJar {
mainClassName = 'com.vmware.osis.Application'
enabled = true
}

jar {
manifest {
attributes 'Main-Class': 'com.vmware.osis.Application'
}
from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
}

subprojects {
apply plugin: 'io.spring.dependency-management'
apply plugin: 'java'
apply plugin: 'idea'

sourceCompatibility = 1.8
targetCompatibility = 1.8
}

sourceSets {
main {
resources {
srcDirs = ["$projectDir/src/main/resources"]
}
}
}

dependencies {
compile project('osis-app')
}

configure(allprojects.findAll { it.name != 'platform-admin-client' }) {
ext {
springBootVersion = '2.2.4.RELEASE'
}
dependencies {
compile "org.springframework.boot:spring-boot-starter-webflux:$springBootVersion"
compile "org.springframework.boot:spring-boot-starter-hateoas:$springBootVersion"
compile "org.springframework.boot:spring-boot-starter-data-jpa:$springBootVersion"
compile "org.springframework.boot:spring-boot-starter-security:$springBootVersion"
testImplementation("org.springframework.boot:spring-boot-starter-test:$springBootVersion") {
exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
}
compile 'io.springfox:springfox-swagger2:2.8.0'
compile 'io.springfox:springfox-swagger-ui:2.8.0'
compile 'javax.xml.bind:jaxb-api:2.2.11'
compile 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.9.5'
compile 'org.openapitools:jackson-databind-nullable:0.1.0'
compile 'javax.validation:validation-api:2.0.1.Final'
compile 'org.hsqldb:hsqldb:2.3.2'
compile 'org.postgresql:postgresql:42.2.13'
compile group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-yaml', version: '2.11.0'
compile group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-xml', version: '2.11.0'
compile group: 'org.apache.commons', name: 'commons-lang3', version: '3.9'
compile 'io.jsonwebtoken:jjwt:0.9.1'
implementation 'org.springframework.plugin:spring-plugin-core:1.2.0.RELEASE'
testCompile group: 'junit', name: 'junit', version: '4.12'
}
}

group = 'com.vmware.osis'
version = '1.0.0'
description = 'osis.platform'
sourceCompatibility = '1.8'

tasks.withType(JavaCompile) {
options.encoding = 'UTF-8'
}
Binary file not shown.
6 changes: 6 additions & 0 deletions vmware-ose-osis-stub/gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#Tue Jun 02 17:48:40 CST 2020
distributionUrl=https\://services.gradle.org/distributions/gradle-6.5.1-all.zip
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStorePath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
Loading

0 comments on commit 7efd8ad

Please sign in to comment.