Bug 1325024 - [DOCS] Metrics deployer template details
Summary: [DOCS] Metrics deployer template details
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.1.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: ---
Assignee: Ashley Hardin
QA Contact: chunchen
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-04-07 21:41 UTC by Eric Jones
Modified: 2019-12-16 05:37 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-07-15 18:39:51 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Eric Jones 2016-04-07 21:41:10 UTC
Document URL: 
https://docs.openshift.com/enterprise/3.1/install_config/cluster_metrics.html#modifying-the-deployer-template

Section Number and Name: 
Deployer Template Parameters

Describe the issue: 
The section briefly mentions that there are several parameters, that can be changed, in the metrics-deployer.yaml file and then proceeds to only talk about 2 parameters.

Suggestions for improvement: 
Include an org chart of the parameters and their default values. Or make it more clear that there are much more parameters in the file.

Comment 1 Ryan Howe 2016-06-15 21:13:49 UTC
List of all parameters. 

- METRIC_DURATION "How many days metrics should be stored for"
- CASSANDRA_PV_SIZE "The persistent volume size for each of the Cassandra nodes"
- CASSANDRA_NODES "The number of Cassandra Nodes to deploy for the initial cluster"
- USE_PERSISTENT_STORAGE "Set to true for persistent storage, set to false to use non persistent storage"
- REDEPLOY "If set to true the deployer will try and delete all the existing components before trying to redeploy."
- HAWKULAR_METRICS_HOSTNAME  "External hostname where clients will reach Hawkular Metrics"
MASTER_URL "Internal URL for the master, for authentication retrieval"
- IMAGE_VERSION  'Specify version for metrics components; e.g. for "openshift/origin-metrics-deployer:latest", set version "latest"'
- IMAGE_PREFIX 'Specify prefix for metrics components; e.g. for "openshift/origin-metrics-deployer:latest", set prefix "openshift/origin-"'

Comment 2 Ashley Hardin 2016-06-27 20:46:22 UTC
Work in progress: https://github.com/openshift/openshift-docs/pull/2370

Comment 3 Ashley Hardin 2016-06-29 14:32:11 UTC
@Eric- Please review: https://github.com/openshift/openshift-docs/pull/2370

Comment 4 Eric Jones 2016-06-29 15:04:40 UTC
LGTM Ashley! Thanks for the work on Docs, always appreciated!

Comment 5 chunchen 2016-06-30 02:04:20 UTC
Will verify it after the PR is merged.

Comment 6 openshift-github-bot 2016-06-30 12:57:58 UTC
Commits pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/eb7afc465c8cd1b03818dc979aecd888e8c44224
Bug 1325024, added deployer template parameters

https://github.com/openshift/openshift-docs/commit/135a2d56e7047de5810e360fc8f0dfde296f5e14
Merge pull request #2370 from ahardin-rh/deployer-parameters

Bug 1325024, added deployer template parameters


Note You need to log in before you can comment on or make changes to this bug.