Skip to content

Commit

Permalink
docs: Update docs after C7 config got removed from Optimize C8 (#5089)
Browse files Browse the repository at this point in the history
* docs: Update docs after C7 config got removed from Optimize C8

* Update optimize/self-managed/optimize-deployment/configuration/system-configuration.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* style(formatting): grammatical tweaks

* docs: rephrase 'Other' section

* docs: remove engine data format

* Update optimize/self-managed/optimize-deployment/configuration/system-configuration.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs: remove engine data format

* Apply suggestions from code review

Co-authored-by: Josh Windels <joshua.windels@camunda.com>

* Update optimize/self-managed/optimize-deployment/configuration/system-configuration.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs: remove ingestedEventCleanup config

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Christina Ausley <christina.ausley@camunda.com>
Co-authored-by: Josh Windels <joshua.windels@camunda.com>
  • Loading branch information
4 people authored Mar 7, 2025
1 parent e05160e commit 0a9d2cd
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 144 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -87,65 +87,6 @@ container:
# Enable use of HTTP/2 for Optimize
http2Enabled: false

# Configuration for engines used to import data. Please note that you have to have at
# least one engine configured at all times.
engines:
# An alias of the engine, which will be used for internal purposes like
# logging and displaying which data belong to which engine.
"camunda-bpm":
# The process engines name on the platform, this is the unique engine identifier on the platforms REST API.
name: default
# A default tenant to the be injected on data from this engine where no tenant is configured in the engine itself.
# This property is only relevant in the context of a `One Process Engine Per Tenant`.
# For details consult the Multi-Tenancy documentation.
defaultTenant:
# the id used for this default tenant on persisted entities
id: null
# the name used for this tenant when displayed in the UI
name: null
#A base URL that will be used for connections to the Camunda Engine REST API.
rest: "http://localhost:8080/engine-rest"
# Determines whether this instance of Optimize should import definition & historical data from this engine.
importEnabled: true
# Determines whether this instance of Optimize should convert historical data to event data
# usable for event based processes.
eventImportEnabled: false
authentication:
# Toggles basic authentication on or off. When enabling basic
# authentication, please be aware that you also need to adjust the values
# of the user and password.
# Also note, when enabled, it is required that the user has
# * READ & READ_HISTORY permission on the Process and Decision Definition resources
# * READ permission on the Authorization, Group, User, Deployment & Tenant resources
# to enable users to log in and Optimize to import the engine data.
enabled: false
# When basic authentication is enabled, this password is used to
# authenticate against the engine.
password: ""
# When basic authentication is enabled, this user is used to authenticate
# against the engine.
user: ""
# The webapps configuration allows Optimize to directly link
# to the other Camunda Web Applications, e.g. to jump from
# Optimize directly to a dedicated process instance in Cockpit
webapps:
# Defines the endpoint where to find the camunda webapps for the given engine
endpoint: "http://localhost:8080/camunda"
# Enables/disables linking to other Camunda Web Applications
enabled: true

engine-commons:
connection:
#Maximum time without connection to the engine, Optimize should wait
#until a time out is triggered. A value of zero means to wait an
# infinite amount of time.
timeout: 0
read:
# Maximum time a request to the engine should last,
# before a timeout triggers. A value of zero means to wait an
# infinite amount of time.
timeout: 0

import:
data:
activity-instance:
Expand Down Expand Up @@ -418,39 +359,6 @@ opensearch:
# process instance can contain. This limit helps to prevent out of memory errors and should be used with care.
nested_documents_limit: 10000

plugin:
# Defines the directory path in the local Optimize file system which should be checked for plugins
directory: "./plugin"
variableImport:
# Look in the given base package list for variable import adaption plugins.
# If empty, the import is not influenced.
basePackages: []
engineRestFilter:
# Look in the given base package list for engine rest filter plugins.
# If empty, the REST calls are not influenced.
basePackages: []
authenticationExtractor:
# Looks in the given base package list for authentication extractor plugins.
# If empty, the standard Optimize authentication mechanism is used.
basePackages: []
decisionInputImport:
# Look in the given base package list for Decision input import adaption plugins.
# If empty, the import is not influenced.
basePackages: []
decisionOutputImport:
# Look in the given base package list for Decision output import adaption plugins.
# If empty, the import is not influenced.
basePackages: []
elasticsearchCustomHeader:
# Look in the given base package list for Elasticsearch custom header fetching plugins.
# If empty, ES requests are not influenced.
basePackages: []

serialization:
# Define a custom date format that should be used for
# fetching date data from the engine(should be the same as in the engine)
engineDateFormat: yyyy-MM-dd'T'HH:mm:ss.SSSZ

alerting:
quartz:
jobStore: "org.quartz.simpl.RAMJobStore"
Expand Down Expand Up @@ -521,17 +429,6 @@ historyCleanup:
# 'myProcessDefinitionKey':
# ttl: 'P2M'
# cleanupMode: 'variables'
decisionDataCleanup:
# switch for the camunda decision data cleanup, defaults to false
enabled: false
# decision definition specific configuration parameters that will overwrite the general parameters (ttl)
# for the specific decisionDefinition key
perDecisionDefinitionConfig:
# 'myDecisionDefinitionKey':
# ttl: 'P2M'
ingestedEventCleanup:
# switch for the ingested event data cleanup, defaults to false
enabled: false

locales:
# all locales available
Expand Down Expand Up @@ -585,12 +482,6 @@ externalVariable:
enabled: false
# Determines the page size for the external variable import, that got ingested via the external variable API
maxPageSize: 10000
variableIngestion:
# Content length limit for the external variable ingestion request in bytes.
# Requests will be rejected when exceeding that limit. Defaults to 10MB.
maxBatchRequestBytes: 10485760
# The maximum number of requests to the external variable ingestion endpoint that can be served at a time.
maxRequests: 5
variableIndexRollover:
# scheduleIntervalInMinutes specifies how frequently the rollover API should be called to see if a rollover of the
# external variable index is required (whether the rollover is triggered depends on the conditions specified by maxIndexSizeGB).
Expand Down
Loading

0 comments on commit 0a9d2cd

Please sign in to comment.