diff options
author | Jon Bratseth <bratseth@yahoo-inc.com> | 2017-01-19 13:30:58 +0100 |
---|---|---|
committer | Jon Bratseth <bratseth@yahoo-inc.com> | 2017-01-19 13:30:58 +0100 |
commit | d9a6d0885f91838bc98e38f7a98729dd0d97846b (patch) | |
tree | 60ff343c7b8b7f8b048a061b88ec935991254d8d | |
parent | 6999811bff537b554ac7084247e50655466f6345 (diff) |
Add/improve README's
-rw-r--r-- | annotations/README | 3 | ||||
-rw-r--r-- | application/README | 6 | ||||
-rw-r--r-- | chain/README | 1 | ||||
-rw-r--r-- | clustercontroller-core/README | 5 | ||||
-rw-r--r-- | config-model-api/README | 5 | ||||
-rw-r--r-- | config-model-fat/README | 5 | ||||
-rw-r--r-- | config-model/README | 4 | ||||
-rw-r--r-- | container-search/README | 2 | ||||
-rw-r--r-- | fileacquirer/README | 1 | ||||
-rw-r--r-- | filedistribution/README | 1 | ||||
-rw-r--r-- | filedistribution_test/README | 1 | ||||
-rw-r--r-- | filedistributionmanager/README | 1 | ||||
-rw-r--r-- | frtstream/README | 1 | ||||
-rw-r--r-- | linguistics/README | 4 | ||||
-rw-r--r-- | messagebus/OWNERS | 3 | ||||
-rw-r--r-- | processing/README | 10 |
16 files changed, 46 insertions, 7 deletions
diff --git a/annotations/README b/annotations/README new file mode 100644 index 00000000000..d51ada27d29 --- /dev/null +++ b/annotations/README @@ -0,0 +1,3 @@ +Custom Vespa Java source annotations + +TODO: Try to move to vespajlib
\ No newline at end of file diff --git a/application/README b/application/README new file mode 100644 index 00000000000..62c8731552c --- /dev/null +++ b/application/README @@ -0,0 +1,6 @@ +API for creating Vespa applications from Java code. + +This has two usages: +- Create fully functional container instances - including HTTP servers - in an existing Java runtime. +- Mock Vespa applications for unit testing. + diff --git a/chain/README b/chain/README new file mode 100644 index 00000000000..b7bdfb904c7 --- /dev/null +++ b/chain/README @@ -0,0 +1 @@ +Java library for creating chains of components with ordering constraints. diff --git a/clustercontroller-core/README b/clustercontroller-core/README new file mode 100644 index 00000000000..24dd50547e1 --- /dev/null +++ b/clustercontroller-core/README @@ -0,0 +1,5 @@ +Core Java library for the Cluster Controller. + +The Cluster Controller makes and publish singular decisions about node states in content clusters, +using ZooKeeper for leader election. Node state decisions must be singular because +they decide bucket mastering (distributor node) and storage (storage node) distribution. diff --git a/config-model-api/README b/config-model-api/README index e8d0877e13e..a84f3507bb6 100644 --- a/config-model-api/README +++ b/config-model-api/README @@ -1,2 +1,3 @@ -This package contains the api for config models to the config server. -No incompatible changes whatsoever may be made to this API as that will break hosted Vespa.
\ No newline at end of file +API to config models used by the config server. +This needs to stay compatible between versions such that the config server can call +config models from different release versions at the same time. diff --git a/config-model-fat/README b/config-model-fat/README index 07e9bd1745a..8718415f871 100644 --- a/config-model-fat/README +++ b/config-model-fat/README @@ -1 +1,4 @@ -This package contains the necessary tools to build the fat config-model bundle. +Repackaging of the config model with all dependencies includes, such that it can be deployed +as a separate bundle to a config server. This allows the config servers to host multiple code +versions of the config model at the same time, to support applications on different versions +at the same time from the same config server. diff --git a/config-model/README b/config-model/README index 89bb3bb3838..d2a10df0298 100644 --- a/config-model/README +++ b/config-model/README @@ -1 +1,3 @@ -This package contains the tools for building the Vespa model. +Java models of Vespa system instances derived from application packages, +used to create configuration for the distributed components of the system. + diff --git a/container-search/README b/container-search/README index 4a070e99b72..36982cab6c1 100644 --- a/container-search/README +++ b/container-search/README @@ -1 +1 @@ -Container layer providing search. +Container layer providing search related functionality. diff --git a/fileacquirer/README b/fileacquirer/README new file mode 100644 index 00000000000..5b42ac9a351 --- /dev/null +++ b/fileacquirer/README @@ -0,0 +1 @@ +Java API for accessing files distributed via file distribution.
\ No newline at end of file diff --git a/filedistribution/README b/filedistribution/README new file mode 100644 index 00000000000..a777872432a --- /dev/null +++ b/filedistribution/README @@ -0,0 +1 @@ +Component for distributing binary files from config servers to cluster nodes, using BitTorrent.
\ No newline at end of file diff --git a/filedistribution_test/README b/filedistribution_test/README new file mode 100644 index 00000000000..1b39ca981ca --- /dev/null +++ b/filedistribution_test/README @@ -0,0 +1 @@ +Tests of filedistribution.
\ No newline at end of file diff --git a/filedistributionmanager/README b/filedistributionmanager/README new file mode 100644 index 00000000000..935a0160136 --- /dev/null +++ b/filedistributionmanager/README @@ -0,0 +1 @@ +Java wrapper of the file distribution component.
\ No newline at end of file diff --git a/frtstream/README b/frtstream/README new file mode 100644 index 00000000000..6c53b361cdd --- /dev/null +++ b/frtstream/README @@ -0,0 +1 @@ +Library used by file distribution.
\ No newline at end of file diff --git a/linguistics/README b/linguistics/README new file mode 100644 index 00000000000..e26a51e2f53 --- /dev/null +++ b/linguistics/README @@ -0,0 +1,4 @@ +Java library for linguistic operations in Vespa. + +This API is pluggable - multiple implementations may be supplied. +This module contains a default pure Java implementation, "simple".
\ No newline at end of file diff --git a/messagebus/OWNERS b/messagebus/OWNERS index 7379f3287ad..46254c9df7c 100644 --- a/messagebus/OWNERS +++ b/messagebus/OWNERS @@ -1,3 +1,2 @@ dybis -baldersheim - +baldersheim
\ No newline at end of file diff --git a/processing/README b/processing/README new file mode 100644 index 00000000000..8c422ed9101 --- /dev/null +++ b/processing/README @@ -0,0 +1,10 @@ +Java library for request-response data processing. + +This library defines request-response processing as an operation which +accepts a Request and produces a Response containing Data by executing +a Chain of processing components in a single worker thread using method +calls for chaining, i.e a synchronous processing model. +Data for the Response may optionally be produced asynchronously. + +The processing model can be implemented by subtyping in frameworks defining +a processing model (with a richer, more specific API) for a particular domain.
\ No newline at end of file |