Skip to content

DOC-9537 -- Remove reference to Static/Dynamic from Bootstrap config … #632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 4, 2022
Merged

DOC-9537 -- Remove reference to Static/Dynamic from Bootstrap config … #632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions modules/ROOT/assets/attachments/sg-bootstrap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,12 @@ properties:
logging:
type: object
description: |+
Holding object for all logging-related settings
Holding object for all logging-related settings.

Note that in addition to setting these logging values here in the bootstrap configuration file, you can also use the ADMIN Rest API to set or change the values without requiring a full reload.
A full logging initalization will be required.

See: [Rest Admin API](rest-api-admin.html)

tags:
- dynamic
Expand All @@ -373,14 +378,17 @@ properties:
type: string
default: none
description: |+
Optionally, log files can be redacted. This means that user-data, considered to be private, is removed. Such data includes:
Optionally, log files can be redacted.
This means that user-data, considered to be private, is removed.
Such data includes:
- Key/value pairs in JSON documents
- Usernames
- Query-fields that reference key/value pairs and/or usernames
- Names and email addresses retrieved during product registration
- Extended attributes

This redaction of user-data is referred to as partial redaction. To enable it, the value must be `"partial"` in the configuration file:
This redaction of user-data is referred to as partial redaction.
To enable it, the value must be `"partial"` in the configuration file:

```json
{
Expand All @@ -399,18 +407,23 @@ properties:
rotation:
type: object
description: |+
The log file may be rotated by defining a "rotation" sub document. See details in the table below.
The log file may be rotated by defining a "rotation" sub document.
See details in the table below.
properties:
max_size:
type: integer
description: The maximum size in MB of the log file before it gets rotated.
default: 100
max_age:
type: integer
description: The maximum number of days to retain old log files. This can't be set below the minimum allowed value for the given level.
description: |+
The maximum number of days to retain old log files.
This can't be set below the minimum allowed value for the given level.
localtime:
type: boolean
description: If true, it uses the computer's local time to format the backup timestamp. False uses UTC.
description: |+
If true, it uses the computer's local time to format the backup timestamp.
False uses UTC.
default: 'false'
rotated_logs_size_limit:
type: integer
Expand Down Expand Up @@ -484,7 +497,8 @@ properties:
Changes require full logging re-initialization
error:
description: |+
The level of logging as a key. Log levels accumulate as you read down the table (i.e log entries at WARN will also be included in the INFO and DEBUG logs).
The level of logging as a key.
Log levels accumulate as you read down the table (i.e log entries at WARN will also be included in the INFO and DEBUG logs).

| Level| Description| Minimum max_age| Log File Name|
| :---| :---| :---| :---|
Expand Down Expand Up @@ -847,8 +861,6 @@ properties:
default: 'false'
description:



tags:
- name: static
description: Static
Expand Down
7 changes: 0 additions & 7 deletions modules/ROOT/pages/configuration-schema-bootstrap.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,6 @@ sync_gateway sync-gateway-bootstrap.json
== Bootstrap Configuration Schema

This schema identifies all the configurable properties.
Note that these properties are either:

* `static` -- changes require a {sgw} reload.
* `dynamic` -- these changes can be applied through the REST endpoint and do not need a SGW restart.
Currently this includes only changes in the `logging` category.
Changes to these properties are not persisted beyond a {sgw} restart.


.Configuration Schema

Expand Down