summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-10-26Docs IndexTrevor Bramwell2-1/+19
Adds the missing index.rst needed to build the documentation. Change-Id: I6ff27873559718a5ca4e3120646a6ef347120c8a Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-10-17Add spinnaker configguidewutianwei2-0/+242
- Supply manifest for creation PV - Add the spinnaker as a service documentation - set the ci.jenkins.enabled to false Change-Id: I66d91aa133085c6c5910913da4303c05fcba9800 Signed-off-by: wutianwei <wutianwei1@huawei.com>
2018-09-19Merge "Local Documentation Builds"Stephen Wong3-0/+6
2018-09-18Local Documentation BuildsAric Gardner3-0/+6
This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: Ifb8fce66e59432863d042a96308e6c3a89fb11a8 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2018-09-07Add ModSecurity config guideJingLu52-0/+294
This patch adds ModSecurity config guide. This patch also deploy the modsecurity and ext_authz filter to clover-gateway namespace. Change-Id: I5ab21e6337b8f8b839ddd028370df378686bd017 Signed-off-by: JingLu5 <lvjing5@huawei.com>
2018-06-15Merge "Add support for node level logging"Stephen Wong1-7/+11
2018-06-15Merge "Fix typo of Jaeger port"Stephen Wong1-1/+1
2018-05-31Add support for node level loggingYujun Zhang1-7/+11
Change-Id: Ib5b2240de3276164fe9e272bf36f0d1f89f409c0 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2018-05-09Fix error in logging installationYujun Zhang1-8/+24
It must be done in two steps otherwise the mixer adapter may not be initialized correctly. Change-Id: Ie59e811fc287fbd52a007be45f0f9c74983149b3 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2018-05-08Fix typo of Jaeger portYujun Zhang1-1/+1
Change-Id: I70b766fe26e750fef6a622344d69ad4f6e2b8962 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2018-04-27Update docs with edits and proper release tagEddie Arrage2-41/+187
- Incorporated feedback from doc reviews - Fix some rendering issues - Add redis inspect section - Update SDC deploy instructions using Fraser release tag Change-Id: I573dcd04066ad83b9c659fae645c65ab4aaa2007 Signed-off-by: Eddie Arrage <eddie.arrage@huawei.com>
2018-04-26Merge "Write A-B configuration guide and align with SDC guide"Stephen Wong3-39/+129
2018-04-26Write A-B configuration guide and align with SDC guideEddie Arrage3-39/+129
- Document A-B sample validation script - Remove redundant TOC in docs - Provide reference links in SDC guide - Additional edits to SDC guide Change-Id: Id4135c99df688f7de1af18017c847a6546082bfc Signed-off-by: Eddie Arrage <eddie.arrage@huawei.com>
2018-04-26Updated user guide with edits and reference linksEddie Arrage3-34/+30
- Provided some overall edits to user guide - Fixed titles of index files for release notes and user guide - Added links to SDC, A-B configuration guides and logging, tracing and monitoring install/validation docs Change-Id: I9a0e1e0a2c12b20400eec5a5642f7c5de2dbd7bf Signed-off-by: Eddie Arrage <eddie.arrage@huawei.com>
2018-04-25Merge "Created config guide for SDC sample app"Stephen Wong6-0/+546
2018-04-25Created config guide for SDC sample appEddie Arrage6-0/+546
- Overview with micro-service diagram - Source diagram file in GIMP with layers for editing by others - Deploying the sample - Using the sample - Exposing Jaeger Tracing and Prometheus monitoring browser interfaces - Modifying run-time micro-service configuration including modifying load balancer server list and adding a custom snort rule - Uninstalling the sample - Updated overview with service description, table and traffic flow description, general edits - Link to A/B configuration guide and doc index file - Additional edits - Diagram for Jaeger UI with SDC Change-Id: I5d851316c05a9e1bd48c8aab5511a98116e6893d Signed-off-by: Eddie Arrage <eddie.arrage@huawei.com>
2018-04-24Simplification of Clover Fraser official docsStephen Wong4-4/+4
(Double commit from master:I89adbef74aa74071a055dcdf62aa0925e263ffe3, gerrit 56167) Change-Id: I86f12d5ba67f09177eca758c184c614ee9d6dd9d Signed-off-by: Stephen Wong <stephen.kf.wong@gmail.com>
2018-04-23Fraser official docs simplificationStephen Wong3-181/+165
[TBD]: link to configguide for sample VNF, link to A-B testing configguide Change-Id: I89adbef74aa74071a055dcdf62aa0925e263ffe3 Signed-off-by: Stephen Wong <stephen.kf.wong@gmail.com>
2018-04-19Merge "Add section to help user understand how logging works"Stephen Wong1-0/+136
2018-04-18Minor edits to release notes and user guidesrpaik2-11/+11
Change-Id: I093fb995f108194367334c4215780b5884d0207a Signed-off-by: rpaik <rpaik@linuxfoundation.org>
2018-04-17Add section to help user understand how logging worksYujun Zhang1-0/+136
Change-Id: Iebfb747450cc08e930eabd36a87670236b23ffff Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2018-04-12Merge "Create index to be included in opnfvdocs site"Stephen Wong2-0/+28
2018-04-12Create index to be included in opnfvdocs siteYujun Zhang2-0/+28
Change-Id: Icbfe547697a8d879f4af8d9f9fbde2211b63129c Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2018-04-11Modified validation script for tracing to support CIEddie Arrage1-6/+13
- Changed default Jaeger ports to 16686 for use with basic kubernetes port-forward and CI scripts - Added CLI to validate script to disable istio service check by default. This requires at least a single http request to istio-ingress after Jaeger deployment. It can be enabled with 'python validate.py -s'. Port and IP address for Jaeger can optionally be specified with '-ip' and '-port' options - Modified tracing doc to add k8s port-forward example in addition to k8s expose Change-Id: I10fb4d3cccfa50370d44ed7446f67a49c538bba9 Signed-off-by: Eddie Arrage <eddie.arrage@huawei.com>
2018-04-04Move design document to dedicated folderYujun Zhang4-0/+15
Change-Id: I20c85b7116cd2b29d0efcaae5ee0b0381a685bbb Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2018-03-30Merge "Initial commit for logging installation and validataion"Stephen Wong1-0/+28
2018-03-30Merge "Initial commit for tracing"Stephen Wong1-0/+44
2018-03-29Initial commit for tracingEddie Arrage1-0/+44
- Uses REST interface to obtain traces for services from Jaeger - Discover services availabe in tracing - Works only with Jaeger at the moment (not zipkin) - Optional Redis interface added to store traces per test - Install doc and validation script added for Jaeger - Renamed doc to docs Change-Id: I420137c818df290ecd40aa8d318c6961c511a947 Signed-off-by: Eddie Arrage <eddie.arrage@huawei.com>
2018-03-29Initial commit for monitoring by prometheusQiLiang1-0/+31
- install prometheus - validate the installation - add prometheus query function - TODO: test collecting telemetry data from istio JIRA: CLOVER-7 Change-Id: I983be2db78c8c5c20c0acee9ae81e891884e07fb Signed-off-by: QiLiang <liangqi1@huawei.com>
2018-03-26clover fraser: preliminary documents checkinStephen Wong2-0/+181
* add preliminary Clover Fraser release notes * add preliminary Clover Fraser user guide Change-Id: I84b0ae1538aaa175245dd47d90ac2343eaa26cc4 Signed-off-by: Stephen Wong <stephen.kf.wong@gmail.com>
2018-03-22Initial commit for logging installation and validataionYujun Zhang1-0/+28
- install fluentd with elastic stack - validate the installation JIRA: CLOVER-5 Change-Id: I181a7277bc332ceac549d384cf2c3817a182b06e Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2018-03-22Create document structureYujun Zhang6-0/+0
See http://docs.opnfv.org/en/latest/how-to-use-docs/documentation-guide.html Note the structure stands on the view of whole OPNFV platform. Change-Id: Id2ac36cb6f30d6d2d54dbda9f6a77b76648aa4b0 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2018-03-22Rename doc to docsYujun Zhang1-0/+0
Change-Id: Iaa83d00704a8d077f8671647b999394eac461482 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>