Skip to content

Commit

Permalink
Merge branch 'rc-1.8.0' into 'master'
Browse files Browse the repository at this point in the history
TS 1.8.0

See merge request automation-toolchain/f5-telemetry!162
  • Loading branch information
petrov-serg committed Nov 28, 2019
2 parents ecb196a + c3e14fa commit 390dff0
Show file tree
Hide file tree
Showing 91 changed files with 9,218 additions and 2,974 deletions.
44 changes: 24 additions & 20 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ stages:
- lint
- test
- build
- doc
- deploy
- functional test
- teardown
Expand Down Expand Up @@ -105,7 +106,7 @@ coverage:
tags:
- cm-official-docker-executor

build_package:
build_rpm:
image: f5devcentral/containthedocs:rpmbuild
stage: build
script:
Expand All @@ -130,6 +131,9 @@ build_docs:
- node scripts/schema-build.js
# - node scripts/schema-check.js
- node scripts/schema-to-rst.js
- if [ "$CI_COMMIT_REF_NAME" = "docs-staging" ] || [ "$CI_COMMIT_REF_NAME" = "docs-latest" ]; then
- rm -rf docs/_templates
- fi
- make html
- vale --glob='*.{md,rst}' .
# - make linkcheck
Expand Down Expand Up @@ -247,7 +251,7 @@ publish_rpm_to_artifactory:
# Publish docs to internal pages - note: this job name MUST be 'pages'
pages:
image: ${CONTAINTHEDOCS_IMAGE}
stage: publish
stage: doc
environment:
name: staging
url: https://${CI_PROJECT_NAMESPACE}.${PAGES_DOMAIN}/${CI_PROJECT_NAME}
Expand Down Expand Up @@ -287,32 +291,32 @@ pages:
- develop

# Publish docs to clouddocs.f5networks.net
# publish_docs_to_staging:
# image: ${CONTAINTHEDOCS_IMAGE}
# stage: publish
# environment:
# name: staging
# url: https://clouddocs.f5networks.net/products/extensions/f5-telemetry-streaming/latest
# tags:
# - cm-official-docker-executor
# only:
# - develop@automation-toolchain/f5-telemetry
# script:
# - aws s3 sync docs/_build/html s3://clouddocs.f5networks.net/products/extensions/f5-telemetry-streaming/latest
# # - aws s3 cp versions.json s3://clouddocs.f5networks.net/products/extensions/f5-telemetry-streaming/versions.json
# # create invalidation to clear cloudfront cache
# - aws cloudfront create-invalidation --distribution-id $AWS_DIST --paths /products/extensions/f5-telemetry-streaming/latest
publish_docs_to_staging:
image: ${CONTAINTHEDOCS_IMAGE}
stage: doc
environment:
name: staging
url: https://clouddocs.f5networks.net/products/extensions/f5-telemetry-streaming/latest
tags:
- cm-official-docker-executor
only:
- docs-staging@automation-toolchain/f5-telemetry
script:
- aws s3 sync docs/_build/html s3://clouddocs.f5networks.net/products/extensions/f5-telemetry-streaming/latest
# - aws s3 cp versions.json s3://clouddocs.f5networks.net/products/extensions/f5-telemetry-streaming/versions.json
# create invalidation to clear cloudfront cache
- aws cloudfront create-invalidation --distribution-id $AWS_DIST --paths /products/extensions/f5-telemetry-streaming/latest

# Publish docs to clouddocs.f5.com
publish_docs_to_production:
image: ${CONTAINTHEDOCS_IMAGE}
stage: publish
stage: doc
environment:
name: production
url: https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest
only:
# fill in desired release branch name to add deployment from a branch: currently *master*
- docs-publish@automation-toolchain/f5-telemetry
# fill in desired release branch name to add deployment from a branch: currently *docs-latest*
- docs-latest@automation-toolchain/f5-telemetry
tags:
- cm-official-docker-executor
script:
Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# Changelog
Changes to this project are documented in this file. More detail and links can be found in the Telemetry Streaming [Document Revision History](https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/revision-history.html).

## 1.8.0
### Added
- AUTOTOOL-487: Add support for filtering (System Poller and Event Listener)
- [GitHub #22](https://github.com/F5Networks/f5-telemetry-streaming/pull/22): Reference to pools in virtual server data
- AUTOTOOl-905: Add machineId to System Poller output
- AUTOTOOL-817: Add Google StackDriver as a consumer

### Fixed
### Changed
- AUTOTOOL-784: Improved error handling to preserve stack trace. Problem was discovered on a Viprion. Opened AUTOTOOL-853 to support Viprion in future.
### Removed

## 1.7.0
### Added
- AUTOTOOL-690: Collect all supported tmstat tables for Splunk Legacy
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Be sure to see the [Support page](SUPPORT.md) in this repo for more details and

## Copyright

Copyright 2014-2018 F5 Networks Inc.
Copyright 2014-2019 F5 Networks Inc.

### F5 Networks Contributor License Agreement

Expand Down
3 changes: 2 additions & 1 deletion SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Currently supported versions:

| Software Version | Release Type | First Customer Ship | End of Support |
|------------------|---------------|---------------------|-----------------|
| TS 1.5.0 | Feature | 30-Jul-2019 | 30-Oct-2019 |
| TS 1.6.0 | Feature | 10-Sep-2019 | 10-Dec-2019 |
| TS 1.7.0 | Feature | 22-Oct-2019 | 22-Jan-2020 |
| TS 1.8.0 | Feature | 03-Dec-2019 | 03-Mar-2020 |

Versions no longer supported:

Expand All @@ -29,6 +29,7 @@ Versions no longer supported:
| TS 1.2.0 | Feature | 02-Apr-2019 | 02-Jul-2019 |
| TS 1.3.0 | Feature | 30-Apr-2019 | 30-Jul-2019 |
| TS 1.4.0 | Feature | 18-Jun-2019 | 18-Sep-2019 |
| TS 1.5.0 | Feature | 30-Jul-2019 | 30-Oct-2019 |


See the [Release notes](https://github.com/F5Networks/f5-telemetry-streaming/releases) and [Telemetry Streaming documentation](https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/userguide/revision-history.html) for new features and issues resolved for each release.
2 changes: 1 addition & 1 deletion contributing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ How does the project handle a typical `POST` request?
"trace": false,
"format": "default"
},
"schemaVersion": "1.7.0"
"schemaVersion": "1.8.0"
}
}
```
Expand Down
22 changes: 15 additions & 7 deletions contributing/process_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

* Check that all `feature` and `docs` branches targeted to the current release were merged to `develop` branch
* Choose the right commit in `develop` branch and create separate branch from it for release candidate with name "vX.Y.Z"
* Update build number changes to:
* Make sure RC branch has actual release version and build numbers in following files, do corrections if needed:
* [package.json](package.json)
* [package-lock.json](package-lock.json)
* [project.spec](project.spec) (not required starting from 1.5)
Expand All @@ -32,18 +32,23 @@
* There should be exact same files across following directories:
* [src/schema/latest](src/schema/latest)
* `src/schema/X.Y.Z` - where X.Y.Z is release version
* Update release version and build numbers in `develop` branch using list of the files above.
* Update [SUPPORT.md](SUPPORT.md) if not yet done (or at least check that everything looks valid):
* add new version to the list of `Currently supported versions` with appropriate dates
* remove no longer supported versions from `Currently supported versions` and add it to `Versions no longer supported`
* Push all changes to GitLab
* Get build artifacts (`.rpm` and `.sha256` checksum) from latest build and:
* Check `.rpm` size, ideally it should not exceed 10 MB. (8.6 MB for 1.4.0)
* Check `.rpm` size, ideally it should not exceed 10 MB.:
* 1.4.0 - 8.6 MB
* 1.7.0 - 8.6 MB
* 1.8.0 - 9.5 MB
* Install build to BIG-IP, navigate to folder `/var/config/rest/iapps/f5-telemetry/` and check following:
* Run `du -sh` and check that folder's size (shouldn't be much greater than previous versions):
* 1.4.0 - 65 MB
* 1.5.0 - 65 MB
* 1.6.0 - 66 MB
* 1.7.0 - 66 MB
* 1.8.0 - 73 MB
* Check `nodejs/node_modules` folder - if you see `eslint`, `mocha` or something else from [package.json](package.json) `devDependencies` section - something wrong with build process. Probably some `npm` flags are work as not expected and it MUST BE FIXED before publishing.
* Ensure that all tests (unit tests and functional tests passed)
* Create pre-release tag and push it to GitLab:
Expand All @@ -55,11 +60,16 @@

## Release process

* Merge RC branch into master - squash to avoid commits leaking sensitive url's, etc.
* git checkout master
* Create new branch from `master`, e.g. `rc-master-branch`. It will be easier to merge branches and resolve conflicts without any following up issues.
* Merge RC branch into RC master branch - squash to avoid commits leaking sensitive url's, etc.
* git checkout rc-master-branch
* git merge --squash vX.Y.Z
* git push origin
* Ideally it will be good to run functional and unit testing
* After that merge `rc-master-branch` to `master` branch:
* git checkout master
* git merge --squash rc-master-branch
* git push origin
* Create tag in master branch:
* git checkout master
* git tag -m 'Release X.Y.Z' vX.Y.Z
Expand All @@ -74,12 +84,10 @@
* git merge master
* git push origin
* Now you can remove RC branch
* Do not forget to clean up stale branches, e.g. RC branches
* Create GitHub release - [GitHub Releases](https://github.com/f5networks/f5-telemetry-streaming/releases)
* Navigate to the latest release, select `edit` and upload artifacts:
* `.rpm` file
* `.sha256` file


In case if you have merge conflicts on attempt to merge RC to 'master' then create new branch from 'master' and try to merge RC changes to this new branch.

# ATTENTION: DO NOT FORGET TO MERGE 'MASTER' BRANCH INTO 'DEVELOP' WHEN YOU ARE DONE WITH RELEASE PROCESS
146 changes: 146 additions & 0 deletions docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
<!DOCTYPE html>
{% extends "basic/layout.html" %}
{{ super() }}



{% set css_files = css_files +
[ "_static/css/bootstrap.min.css",
"_static/css/f5.css",
"_static/css/f5-theme.css",
"_static/css/CoveoFullSearch.css",
"_static/css/custom.css",
"https://use.fontawesome.com/21fb8a09c3.css" ] %}

{% set script_files = script_files + [
"https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/jquery.mark.js"
]%}

{% include "head.html" %}

<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-PPZPQ6" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->

{# Do not create the standard relbars and sidebars #}
{%- block relbar1 %}{% endblock %}
{%- block relbar2 %}{% endblock %}
{%- block sidebar1 %}{% endblock %}
{%- block sidebar2 %}{% endblock %}

{%- block header %}
<div id="clouddocs-header"></div>
{% endblock %}

<div class="wrapper">

<div id="docs-wrapper" itemscope itemtype="http://schema.org/Article">

{% block content %}

{%- if sidebars != None %}
{%- block f5sidebar %}
<div id="sidebar" class="section-nav">
{% if (theme_version_selector) %}
<!-- version selector ------------------>
<div id="version_selector_wrapper">
</div>
{%- endif %}
<nav class="nav-sidebartoc">

{% if release %}
<h5>{{ project }} {{ release }} </h5>
{% else %}
<h5>{{ project }} {{ version }} </h5>
{% endif %}

<hr>
<span class="nav-sidebartoc">
{{ toctree(includehidden=True, collapse=True) }}
</span>
{%- include "extralinks.html" %}
</nav>
</div>


<div id="right-sidebar">
<h7 style="font-weight:normal">On this page:</h7>
<nav class="nav-sidebartoc">
<span class="nav-sidebartoc">
{{ toc }}
</span>
</nav>
</div>


{%- endblock %}
{%- endif %}





{% block main %}
<div class="main active" id="content" >
<article class="docs-container site-article-inner">

{%- block breadcrumb %}
{% include "breadcrumb.html" %}
{% endblock %}


<!--a title="Export PDF" id="export-pdf" class="btn btn btn-link pull-right">View PDF</a-->
<button type="button" id="export-pdf" class="btn btn-link right">PDF</button>


{% if (theme_version_selector) %}
{% if (theme_enable_version_warning_banner) %}
<div class="sidebar" id="version-warning" style="display: none;">
<p class="first sidebar-title">
<span class="icon fa fa-info-circle fa-lg"></span> Version notice:</p>
<p class="last" id="currentVersion"></p>
</div>
{%- endif %}
{%- endif %}


<div role="main">
{% block body %}{% endblock %}
</div>
{% if (next or prev) and (theme_next_prev_link) %}
<div class="row next-prev-btn-row">
<div class="col-lg-12">
{% if prev %}
<a href="{{ prev.link|e }}" title="{{ prev.title|striptags|e }}" accesskey="p" class="btn btn-primary left"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i> Previous</a>
{% endif %}
{% if next %}
<a href="{{ next.link|e }}" title="{{ next.title|striptags|e }}" accesskey="n" class="btn btn-primary right">Next <i class="fa fa-arrow-circle-right" aria-hidden="true"></i></a>
{% endif %}
</div>
</div>
{% endif %}

</article>
</div>
{%- endblock %}

</div>

{% endblock %}
</div>

{%- block footer %}
<div id="clouddocs-footer"></div>
<!-- Bootstrap core JavaScript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
{% if (theme_version_selector) %}
<script src="{{ pathto('_static/js/index.js', 1) }}"></script>
{%- endif %}
<script src="{{ pathto('_static/js/jquery.appear.js', 1) }}"></script>
<script src="{{ pathto('_static/js/printThis.js', 1) }}"></script>
<script src="{{ pathto('_static/js/bootstrap.min.js', 1) }}"></script>
<script src="{{ pathto('_static/js/clouddocs.js', 1) }}"></script>
<script src="{{ pathto('_static/js/CoveoJsSearch.Lazy.min.js', 1) }}"></script>

{%- endblock %}
13 changes: 0 additions & 13 deletions docs/about-telemetry.rst

This file was deleted.

16 changes: 0 additions & 16 deletions docs/additional-examples.rst

This file was deleted.

Loading

0 comments on commit 390dff0

Please sign in to comment.