From 4f1fb82d0744aef87676a29fe05fc55db2c0450b Mon Sep 17 00:00:00 2001 From: Anyways Date: Tue, 6 Dec 2016 10:38:03 +0800 Subject: [PATCH] update readme --- .travis.yml | 4 +-- README.md | 95 +++++++++++++++++++++++++++++++++++++---------------- 2 files changed, 68 insertions(+), 31 deletions(-) diff --git a/.travis.yml b/.travis.yml index 8081b1a..863d8a5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,9 +3,7 @@ language: java jdk: - openjdk7 -script: mvn clean compile - -install: mvn package -DskipTests +script: mvn package -DskipTests branches: only: diff --git a/README.md b/README.md index 115f75c..fb180f9 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,83 @@ -Providers of JClouds for Aliyun +## Providers of JClouds for Aliyun [![Build Status](https://travis-ci.org/aliyun-beta/aliyun-jclouds.svg?branch=master)](https://travis-ci.org/aliyun-beta/aliyun-jclouds) -#### *modules* -* aliyun-ecs **jclouds-compute** -* aliyun-oss **jclouds-blobstore** -* aliyun-slb **jclouds-loadbalancer** +### Introduction -| Name | Type | +aliyun-jclouds adapt for jclouds to use cloud service of [aliyun](https://www.aliyun.com) + +### Providers + +| Provider | Service | |------|------| -|aliyun-ecs|provider| -|aliyun-oss|provider| -|aliyun-slb|provider| +|aliyun-ecs|ComputeService| +|aliyun-oss|BlobStore| +|aliyun-slb|LoadBalancerService| + +### Maven + + + + io.github.aliyun-beta + aliyun-ecs + 1.0.0 + + + io.github.aliyun-beta + aliyun-oss + 1.0.0 + + + io.github.aliyun-beta + aliyun-slb + 1.0.0 + + + +### Usage + +Offical documents link [Apache-jclouds](http://jclouds.apache.org/start) -#### *compile* -Providers use **Google Auto** to generate services +###### ComputeService -**It is important to do like this** -> mvn clean compile + ComputeService computeService; + String provider = "aliyun-ecs"; + String key = "Your AccessKey"; + String secret = "Your AccessKeySecret"; + ComputeServiceContext context = ContextBuilder + .newBuilder(provider) + .credentials(key, secret) + .buildView(ComputeServiceContext.class); + computeService = context.getComputeService(); -Then you will find an folder named services from target\classes\META-INF in each modules +###### BlobStore -If you do not do the operation, an error will happends. + BlobStore blobStore; + String provider = "aliyun-oss"; + String key = "Your AccessKey"; + String secret = "Your AccessKeySecret"; + BlobStoreContext context = ContextBuilder + .newBuilder(provider) + .credentials(key, secret) + .buildView(BlobStoreContext.class); + blobStore = context.getBlobStore(); - key [aliyun-ecs] not in the list of providers or apis +###### LoadBalancerService -#### *test* -Please change the accessKey and secret witch generate by your own account of [Aliyun](http://www.aliyun.com) in each test classes before test + LoadBalancerService loadBalancerService; + String provider = "aliyun-slb"; + String key = "Your AccessKey"; + String secret = "Your AccessKeySecret"; + LoadBalancerServiceContext context = ContextBuilder + .newBuilder(provider) + .credentials(key, secret) + .buildView(LoadBalancerServiceContext.class); + loadBalancerService = context.getLoadBalancerService(); - private static final String key = "nyCUviU59zdxOIYJ"; - private static final String secret = "VX99Yry885o0lpjFgzIpjibrVJIGgB"; +### Build -Then run command -> mvn test +> mvn package -DskipTests -#### *changelog* -| Date | Message | -|------|---------| -|2016-01-17|push for checking| -|2016-01-25|fix some bugs| +### License -#### License Licensed under the Apache License, Version 2.0