[
https://issues.apache.org/jira/browse/DTACLOUD-198?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ronelle Landy updated DTACLOUD-198:
-----------------------------------
Description:
The Deltacloud directories contain a number of text files with documentation,
examples, download and license-related information. Some of the info in these
files is out of date, pointing to the 'incubator' site, dates from 2010, 2011
and svn repos. A list of some files found that need review is included below.
There may be additional files - so recommendation is to grep and check those
similar files.
- deltacloud/NOTICE
- deltacloud/server/README.md
- deltacloud/<server and client>/NOTICE (maybe copyright?)
****************************************************************
An example of the 'out of date' text in deltacloud/server/README.md is copied
below:
See svn repo references and links to incubator site:
[root@qe-blade-14 server]# cat /deltacloud/server/README.md
Deltacloud API
==============
Hooray, you have successfully checked out Deltacloud Core.
Deltacloud protects yourapps from cloud API changes and incompatibilities,
so you can concentrate on managing cloud instances the way you want.
You can find more documentation at the Deltacloud web site at:
[incubator.apache.org/deltacloud](http://incubator.apache.org/deltacloud/)
Prerequisites
-------------
Deltacloud Core depends on a number of other Ruby libraries. The easiest
way to install them is to either install the deltacloud-core package from
your distribution is repository, e.g. `yum install deltacloud-core` on
Fedora, or install the gem with `gem install deltacloud-core`.
If you do not want to do that, have a look at the dependencies in the gem
spec for deltacloud-core and install them manually from git repository:
$ mkdir deltacloud
$ cd deltacloud
$ git svn init -s https://svn.apache.org/repos/asf/incubator/deltacloud
$ git svn fetch --log-window-size 10000
$ git clone git://git.apache.org/deltacloud.git core
Running
-------
To get started, run `./bin/deltacloudd -i mock`; this will run Deltacloud
Core with the mock driver, a driver that does not talk to a cloud, but
simulates being one. It will store data about its instances etc. in
`/var/tmp/deltacloud-mock-$USER`; that directory will automatically populated
with sample data if it does not exist. Subsequent runs will continue using
the data found there. If you need to start over from scratch, just delete
that directory and restart deltacloudd.
Once you have the server running, point your browser at
[localhost:3001/api](http://localhost:3001/api) to get a HTML version of
Deltacloud Core.
If you want to look at the XML that REST clients will see, simply add
`?format=xml` to URLs. Deltacloud Core does content negotiation; REST clients
should not
set _format_ to URLs, they should simply set the _Accept_ header appropriately.
Some operations require authentication. For the mock driver, the username
and password are *mockuser* and *mockpassword*. A current list of drivers
and what kind of credentials they need can be found at
Deltacloud Incubator site (http://incubator.apache.org/deltacloud/drivers.html)
Happy hacking - and do not forget to send patches to the mailing list (see
[deltacloud-devel](https://fedorahosted.org/mailman/listinfo/deltacloud-devel)
or
[incubator-deltacloud-dev](http://mail-archives.apache.org/mod_mbox/incubator-deltacloud-dev)
You could send patches using `git format-patch master` and then `git send-email
--thread`. Example _git/.config_ file:
[sendemail]
to = [email protected]
signedoffbycc=no
chainreplyto=no
smtpserver=YOUR_SMTP_SERVER_HERE
thread=yes
from=YOUR_EMAIL_HERE
suppresscc=all
was:
See svn repo references and links to incubator site:
[root@qe-blade-14 server]# cat /deltacloud/server/README.md
Deltacloud API
==============
Hooray, you have successfully checked out Deltacloud Core.
Deltacloud protects yourapps from cloud API changes and incompatibilities,
so you can concentrate on managing cloud instances the way you want.
You can find more documentation at the Deltacloud web site at:
[incubator.apache.org/deltacloud](http://incubator.apache.org/deltacloud/)
Prerequisites
-------------
Deltacloud Core depends on a number of other Ruby libraries. The easiest
way to install them is to either install the deltacloud-core package from
your distribution is repository, e.g. `yum install deltacloud-core` on
Fedora, or install the gem with `gem install deltacloud-core`.
If you do not want to do that, have a look at the dependencies in the gem
spec for deltacloud-core and install them manually from git repository:
$ mkdir deltacloud
$ cd deltacloud
$ git svn init -s https://svn.apache.org/repos/asf/incubator/deltacloud
$ git svn fetch --log-window-size 10000
$ git clone git://git.apache.org/deltacloud.git core
Running
-------
To get started, run `./bin/deltacloudd -i mock`; this will run Deltacloud
Core with the mock driver, a driver that does not talk to a cloud, but
simulates being one. It will store data about its instances etc. in
`/var/tmp/deltacloud-mock-$USER`; that directory will automatically populated
with sample data if it does not exist. Subsequent runs will continue using
the data found there. If you need to start over from scratch, just delete
that directory and restart deltacloudd.
Once you have the server running, point your browser at
[localhost:3001/api](http://localhost:3001/api) to get a HTML version of
Deltacloud Core.
If you want to look at the XML that REST clients will see, simply add
`?format=xml` to URLs. Deltacloud Core does content negotiation; REST clients
should not
set _format_ to URLs, they should simply set the _Accept_ header appropriately.
Some operations require authentication. For the mock driver, the username
and password are *mockuser* and *mockpassword*. A current list of drivers
and what kind of credentials they need can be found at
Deltacloud Incubator site (http://incubator.apache.org/deltacloud/drivers.html)
Happy hacking - and do not forget to send patches to the mailing list (see
[deltacloud-devel](https://fedorahosted.org/mailman/listinfo/deltacloud-devel)
or
[incubator-deltacloud-dev](http://mail-archives.apache.org/mod_mbox/incubator-deltacloud-dev)
You could send patches using `git format-patch master` and then `git send-email
--thread`. Example _git/.config_ file:
[sendemail]
to = [email protected]
signedoffbycc=no
chainreplyto=no
smtpserver=YOUR_SMTP_SERVER_HERE
thread=yes
from=YOUR_EMAIL_HERE
suppresscc=all
Summary: README, NOTICE, DISCLAIMER files need to be updated - include
old dates, incubator site links and svn repos (was:
/deltacloud/server/README.md needs to be updated - includes incubator site
links and svn repos)
> README, NOTICE, DISCLAIMER files need to be updated - include old dates,
> incubator site links and svn repos
> -----------------------------------------------------------------------------------------------------------
>
> Key: DTACLOUD-198
> URL: https://issues.apache.org/jira/browse/DTACLOUD-198
> Project: DeltaCloud
> Issue Type: Bug
> Components: Server
> Environment: Fedora 16
> deltacloud git commit version: c13da7b50bbbbdc529b42207f58dbe5099006ad1
> clone: from https://git-wip-us.apache.org/repos/asf/deltacloud.git
> Reporter: Ronelle Landy
> Assignee: David Lutterkort
>
> The Deltacloud directories contain a number of text files with documentation,
> examples, download and license-related information. Some of the info in
> these files is out of date, pointing to the 'incubator' site, dates from
> 2010, 2011 and svn repos. A list of some files found that need review is
> included below. There may be additional files - so recommendation is to grep
> and check those similar files.
> - deltacloud/NOTICE
> - deltacloud/server/README.md
> - deltacloud/<server and client>/NOTICE (maybe copyright?)
> ****************************************************************
> An example of the 'out of date' text in deltacloud/server/README.md is copied
> below:
> See svn repo references and links to incubator site:
> [root@qe-blade-14 server]# cat /deltacloud/server/README.md
> Deltacloud API
> ==============
> Hooray, you have successfully checked out Deltacloud Core.
> Deltacloud protects yourapps from cloud API changes and incompatibilities,
> so you can concentrate on managing cloud instances the way you want.
> You can find more documentation at the Deltacloud web site at:
> [incubator.apache.org/deltacloud](http://incubator.apache.org/deltacloud/)
> Prerequisites
> -------------
> Deltacloud Core depends on a number of other Ruby libraries. The easiest
> way to install them is to either install the deltacloud-core package from
> your distribution is repository, e.g. `yum install deltacloud-core` on
> Fedora, or install the gem with `gem install deltacloud-core`.
> If you do not want to do that, have a look at the dependencies in the gem
> spec for deltacloud-core and install them manually from git repository:
> $ mkdir deltacloud
> $ cd deltacloud
> $ git svn init -s https://svn.apache.org/repos/asf/incubator/deltacloud
> $ git svn fetch --log-window-size 10000
> $ git clone git://git.apache.org/deltacloud.git core
> Running
> -------
> To get started, run `./bin/deltacloudd -i mock`; this will run Deltacloud
> Core with the mock driver, a driver that does not talk to a cloud, but
> simulates being one. It will store data about its instances etc. in
> `/var/tmp/deltacloud-mock-$USER`; that directory will automatically populated
> with sample data if it does not exist. Subsequent runs will continue using
> the data found there. If you need to start over from scratch, just delete
> that directory and restart deltacloudd.
> Once you have the server running, point your browser at
> [localhost:3001/api](http://localhost:3001/api) to get a HTML version of
> Deltacloud Core.
> If you want to look at the XML that REST clients will see, simply add
> `?format=xml` to URLs. Deltacloud Core does content negotiation; REST clients
> should not
> set _format_ to URLs, they should simply set the _Accept_ header
> appropriately.
> Some operations require authentication. For the mock driver, the username
> and password are *mockuser* and *mockpassword*. A current list of drivers
> and what kind of credentials they need can be found at
> Deltacloud Incubator site
> (http://incubator.apache.org/deltacloud/drivers.html)
> Happy hacking - and do not forget to send patches to the mailing list (see
> [deltacloud-devel](https://fedorahosted.org/mailman/listinfo/deltacloud-devel)
> or
> [incubator-deltacloud-dev](http://mail-archives.apache.org/mod_mbox/incubator-deltacloud-dev)
> You could send patches using `git format-patch master` and then `git
> send-email
> --thread`. Example _git/.config_ file:
> [sendemail]
> to = [email protected]
> signedoffbycc=no
> chainreplyto=no
> smtpserver=YOUR_SMTP_SERVER_HERE
> thread=yes
> from=YOUR_EMAIL_HERE
> suppresscc=all
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
