Adopting cross references to Github markdown
This commit is contained in:
parent
9cb1738c4d
commit
8b1fd41e6d
@ -66,7 +66,7 @@ For convenience we also provide a storlet all-in-one installation script that in
|
||||
See <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/storlets_all_in_one.rst>
|
||||
The installation is based on Ansible and was tested on Ubuntu 14.10, and with Swift 1.13 and Swift 2.2.
|
||||
|
||||
Once installation is completed, you can try run the system tests as described in the <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/storlets_installation_guide.rst>
|
||||
Once installation is completed, you can try run the system tests as described in the <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/dev_and_test_guide.rst>
|
||||
The system tests are a good reference for writing and deploying a Storlet.
|
||||
|
||||
Status
|
||||
|
@ -24,7 +24,7 @@ Below are the steps of this flow:
|
||||
|
||||
#. A prerequisite for the account manager to deploy a Docker image to Swift is having an
|
||||
account that is enabled for Storlets. This is an operation that is done by the Swift Storlet
|
||||
manager and is explained in storlets_management.rst.
|
||||
manager and is explained in <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/storlets_management.rst>.
|
||||
#. Once the account is enabled for Storlets, a container named docker_images is
|
||||
created, with access to both the account manager as well as the storlet manager.
|
||||
That container will include a basic Docker image consisting of some Storlet
|
||||
@ -33,7 +33,7 @@ Below are the steps of this flow:
|
||||
the installed software stack, and upload it back to the docker_images container.
|
||||
#. Once uploaded, the account manager must notify the Swift Storlet engine manager
|
||||
of the update. The storlets manager would take care of testing and deploying
|
||||
it to all Swift nodes. storlets_management.rst describes the provided tool
|
||||
it to all Swift nodes. Again, <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/storlets_management.rst> describes the provided tool
|
||||
the Storlet manager can use for the actual deployment.
|
||||
|
||||
The below sections describe in details the steps taken by the account manager
|
||||
|
@ -4,7 +4,7 @@ Development and Testing
|
||||
|
||||
This guide explains how to build the various components, and how to deploy them once built.
|
||||
Note that some of the components being built need to be inserted to a docker image before
|
||||
they can be tested. Thus, once should have an installed environment (see storlet_installation_guide.rst)
|
||||
they can be tested. Thus, once should have an installed environment (see <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/storlet_installation_guide.rst>)
|
||||
before proceeding with the test and deploy steps (which are in fact a subset of the installation steps).
|
||||
|
||||
Building
|
||||
|
@ -5,7 +5,7 @@ Introduction
|
||||
The Storlet manager operations currently include:
|
||||
|
||||
#. Creating a Storlet enabled tenant.
|
||||
#. Deploying an image that was created by the tenant admin as described in building_and_deploying_docker_images.rst
|
||||
#. Deploying an image that was created by the tenant admin as described in <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/building_and_deploying_docker_images.rst>
|
||||
|
||||
The scripts providing these operations are located under /opt/ibm in the storlet management machine.
|
||||
|
||||
@ -29,7 +29,7 @@ The script takes 3 parameters:
|
||||
#. The password for the account manager
|
||||
|
||||
Note that the script is aware of the Keysone admin credentials as they
|
||||
were provided to the initial installation script as described in storlets_installation_guide.rst
|
||||
were provided to the initial installation script as described in <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/storlets_installation_guide.rst>
|
||||
|
||||
Below is a sample invocation:
|
||||
|
||||
@ -93,7 +93,7 @@ Below is a sample invocation:
|
||||
|
||||
Deploying a Tenant Image
|
||||
========================
|
||||
Recall that in the Docker image build (described in building_and_deploying_docker_images.rst) the image was given a name
|
||||
Recall that in the Docker image build (described in <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/building_and_deploying_docker_images.rst>) the image was given a name
|
||||
(specified after -t in the docker build command) and was uploaded as a .tar file to the tenant's docker_images Swift container.
|
||||
When deploying an image, the Storlet's admin needs to provide the tenant name, the .tar object name and the image name.
|
||||
|
||||
|
@ -26,7 +26,7 @@ how the Storlet is written):
|
||||
and can output user metadata.
|
||||
|
||||
To write a storlet you will need the SCommon.jar which is being built as part of
|
||||
the Storlets build process (see dev_and_test_guide.rst). Import the .jar to a Java
|
||||
the Storlets build process (see <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/dev_and_test_guide.rst>). Import the .jar to a Java
|
||||
project in Eclipse and implement the com.ibm.storlet.common.IStorlet interface.
|
||||
The interface has a single method that looks like this:
|
||||
|
||||
@ -70,7 +70,7 @@ Here is a class diagram illustrating the classes involved in the above API.
|
||||
in a designated container called storletlog by default, and will carry the name
|
||||
<storlet_name>.log. Creating an object containing the logs per request has its
|
||||
overhead. Thus, the actual creation of the logs object is controlled by a header
|
||||
supplied during storlet invocation. More information is given in invoking_storlets.rst
|
||||
supplied during storlet invocation. More information is given in <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/invoking_storlets.rst>
|
||||
|
||||
When invoked via the Swift GET REST API the invoke method
|
||||
will be called as follows:
|
||||
@ -82,7 +82,7 @@ will be called as follows:
|
||||
stream is effectively written to the response body returned to the user's GET
|
||||
request.
|
||||
#. The parameters map includes execution parameters sent. These parameters can be
|
||||
specified in the storlet execution request. See invoking_storlets.rst
|
||||
specified in the storlet execution request. See <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/invoking_storlets.rst>
|
||||
**IMPORTANT: Do not use parameters that start with 'storlet_' these are
|
||||
kept for system parameters that the storlet can use.**
|
||||
#. A StorletLogger instance.
|
||||
|
Loading…
x
Reference in New Issue
Block a user