Skip to content

Product Configuration #1865

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

Open
wants to merge 36 commits into
base: main
Choose a base branch
from
+1,016 −328
Open

Product Configuration #1865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
39befc6
Introduce products.yml as the central resource to catalogue primary p…
cotti Sep 3, 2025
a2ebf39
Adjust legacy URL mapping to use Product metadata
cotti Sep 3, 2025
d663ede
Merge branch 'main' into feature/product_config
cotti Sep 3, 2025
9521c8a
Refactor legacy-url-mappings.yml, update values on versions.yml and p…
cotti Sep 10, 2025
752f80d
Merge branch 'main' into feature/product_config
cotti Sep 10, 2025
c9a7ec3
Fix merge
cotti Sep 10, 2025
d328e32
Refactor location of Product
cotti Sep 10, 2025
6361eb1
Fix property definition
cotti Sep 10, 2025
1ddfa3e
Refactor loading Product and LegacyUrlMapping data
cotti Sep 10, 2025
ed9aeb1
Add documentation
cotti Sep 10, 2025
626c199
Fix legacy version lists with 9.0+ entries
cotti Sep 10, 2025
806259e
Standardize with underscores
cotti Sep 10, 2025
0434e00
Update docs/configure/site/products.md
cotti Sep 10, 2025
d4a2167
Update docs/configure/site/products.md
cotti Sep 10, 2025
ea83361
Merge branch 'main' into feature/product_config
cotti Sep 10, 2025
bad491a
Merge branch 'main' into feature/product_config
cotti Sep 10, 2025
b527459
Merge branch 'main' into feature/product_config
cotti Sep 10, 2025
b6e1e51
Merge remote-tracking branch 'origin/feature/product_config' into fea…
cotti Sep 10, 2025
03f3ccf
Revert to kebab-case product definition and allow compatibility with …
cotti Sep 10, 2025
c0130e4
Fix lint
cotti Sep 10, 2025
7ee832e
Standardize on underscores as it is more widely used by writers
cotti Sep 10, 2025
9ba7cf7
Merge branch 'main' into feature/product_config
cotti Sep 10, 2025
4559374
Merge branch 'main' into feature/product_config
cotti Sep 11, 2025
1234a84
Update config/products.yml
cotti Sep 11, 2025
84e9be7
Merge remote-tracking branch 'origin/feature/product_config' into fea…
cotti Sep 11, 2025
8f7e77d
Remove obsolete EqualityComparer
cotti Sep 11, 2025
0175253
Adjust product listing
cotti Sep 11, 2025
4627aec
Minor clean-ups
cotti Sep 11, 2025
a69fa1e
Adding non-product entries back
cotti Sep 11, 2025
a0c2bc1
Remove duplicate version entries between versions.yml and the legacy …
cotti Sep 11, 2025
43b9561
Merge branch 'main' into feature/product_config
cotti Sep 11, 2025
f064443
FIx tests and ecctl definition
cotti Sep 12, 2025
daa393c
Use a static deserializer through the same assembly
cotti Sep 12, 2025
741c1ec
Adjust product id for ecctl and fix flexibility rules
cotti Sep 12, 2025
2372b84
Support underscores and dashes in substitutions
cotti Sep 12, 2025
d395917
Merge branch 'main' into feature/product_config
cotti Sep 12, 2025
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
296 changes: 221 additions & 75 deletions config/legacy-url-mappings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,82 +1,228 @@
#############################################
# This file defines the legacy URL mappings for the documentation site.
# It maps current documentation pages to older versions to ensure users can find the content they need.
# TODO: Refactor the model, for now we just use the first element as current version
# Upon creation of version selection dropdowns, this data is combined with the current version of its product.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how does this interact with mapped_pages now?

#############################################

stack: &stack [ '9.0+', '8.19', '8.18', '8.17', '8.16', '8.15', '8.14', '8.13', '8.12', '8.11', '8.10', '8.9', '8.8', '8.7', '8.6', '8.5', '8.4', '8.3', '8.2', '8.1', '8.0', '7.17' ]
stack: &stack [ '8.19', '8.18', '8.17', '8.16', '8.15', '8.14', '8.13', '8.12', '8.11', '8.10', '8.9', '8.8', '8.7', '8.6', '8.5', '8.4', '8.3', '8.2', '8.1', '8.0', '7.17' ]

mappings:
en/apm/agent/android/: [ '1.2.0' , '0.x' ]
en/apm/agent/dotnet/: [ '1.34.0' ]
en/apm/agent/go/: [ '2.7.1', '1.x', '0.5' ]
en/apm/agent/java/: ['1.54.0', '0.7', '0.6']
en/apm/agent/nodejs/: [ '4.x', '3.x', '2.x', '1.x' ]
en/apm/agent/php/: [ '1.15.1', '1.x' ]
en/apm/agent/python/: [ '6.24.0', '5.x', '4.x', '3.x', '2.x', '1.x' ]
en/apm/agent/ruby/: [ '4.8.0', '3.x', '2.x', '1.x' ]
en/apm/agent/rum-js/: [ '5.17.0', '4.x', '3.x', '2.x', '1.x', '0.x' ]
en/apm/agent/swift/: [ '1.2.1', '0.x' ]
en/apm/attacher/: [ '1.1.3' ]
en/apm/lambda/: [ '1.5.8' ]
en/beats/auditbeat/: *stack
en/beats/devguide/: *stack
en/beats/filebeat/: *stack
en/beats/functionbeat/: *stack
en/beats/heartbeat/: *stack
en/beats/journalbeat/: *stack
en/beats/libbeat/: *stack
en/beats/loggingplugin/: *stack
en/beats/metricbeat/: *stack
en/beats/packetbeat/: *stack
en/beats/topbeat/: *stack
en/beats/winlogbeat/: *stack
en/cloud-heroku/: []
en/cloud-on-k8s/: [ '3.0+', '2.16', '2.15', '2.14', '2.13', '2.12', '2.11', '2.10', '2.9', '2.8', '2.7', '2.6', '2.5', '2.4', '2.3', '2.2', '2.1', '2.0', '1.9', '1.8', '1.7', '1.6', '1.5', '1.4', '1.3', '1.2', '1.1', '1.0' ]
en/cloud/: []
en/cloud-enterprise/: [ '4.0', '3.8', '3.7', '3.6', '3.5', '3.4', '3.3', '3.2', '3.1', '3.0', '2.13', '2.12', '2.11', '2.10', '2.9', '2.8', '2.7', '2.6', '2.5', '2.4', '2.3', '2.2', '2.1', '2.0', '1.1', '1.0' ]
en/ecctl/: [ '1.14+', '1.13', '1.12', '1.11', '1.10', '1.9', '1.8', '1.7', '1.6', '1.5', '1.4', '1.3', '1.2', '1.1', '1.0' ]
en/ecs-logging/: []
en/ecs-logging/dotnet/: [ '8.18.1' ]
en/ecs-logging/go-logrus/: [ '1.0.0' ]
en/ecs-logging/go-zap/: [ '1.0.3' ]
en/ecs-logging/go-zerolog/: [ '0.2.0' ]
en/ecs-logging/java/: [ '1.7.0', '0.x' ]
en/ecs-logging/nodejs/: [ '1.5.3' ]
en/ecs-logging/overview/: []
en/ecs-logging/php/: [ '2.0.0' ]
en/ecs-logging/python/: [ '2.2.0' ]
en/ecs-logging/ruby/: ['1.0.0']
en/ecs/: [ '9.0+', '8.18', '8.17', '8.16', '8.15', '8.14', '8.13', '8.12', '8.11', '8.10', '8.9', '8.8', '8.7', '8.6', '8.5', '8.4', '8.3', '8.2', '8.1', '8.0', '1.12', '1.11', '1.10', '1.9', '1.8', '1.7', '1.6', '1.5', '1.4', '1.3', '1.2', '1.1', '1.0' ]
en/elastic-stack-glossary/: []
en/elastic-stack/: *stack
en/elasticsearch/client/curator/: [ '8.0.21', '7.0', '6.0', '5.8', '5.7', '5.6', '5.5', '5.4', '5.3', '5.2', '5.1', '5.0', '4.3', '4.2', '4.1', '4.0', '3.5', '3.4', '3.3' ]
en/elasticsearch/client/eland/: [ '9.0.1' ]
en/elasticsearch/client/go-api/: *stack
en/elasticsearch/client/java-api-client/: *stack
en/elasticsearch/client/javascript-api/: *stack
en/elasticsearch/client/net-api/: *stack
en/elasticsearch/client/php-api/: *stack
en/elasticsearch/client/python-api/: *stack
en/elasticsearch/client/ruby-api/: *stack
en/elasticsearch/client/rust-api/: *stack
en/elasticsearch/hadoop/: *stack
en/elasticsearch/painless/: *stack
en/elasticsearch/plugins/: *stack
en/elasticsearch/reference/: *stack
en/esf/: ['1.20.1']
en/fleet/: *stack
en/ingest-overview/: []
en/ingest/: *stack
en/integrations-developer/: []
en/integrations/: []
en/kibana/: *stack
en/logstash-versioned-plugins/: []
en/logstash/: *stack
en/machine-learning/: *stack
en/observability/: *stack
en/reference-architectures/: []
en/search-ui/: ['1.24.0']
en/security/: *stack
en/serverless/: []
en/starting-with-the-elasticsearch-platform-and-its-solutions/: *stack
en/apm/agent/android/:
product: apm-agent-android
legacy_versions: [ '0.x' ]
en/apm/agent/dotnet/:
product: apm-agent-dotnet
legacy_versions: [ '1.33.0' ]
en/apm/agent/go/:
product: apm-agent-go
legacy_versions: [ '1.x', '0.5' ]
en/apm/agent/java/:
product: apm-agent-java
legacy_versions: [ '1.54.0', '0.7', '0.6']
en/apm/agent/nodejs/:
product: apm-agent-node
legacy_versions: [ '4.x', '3.x', '2.x', '1.x' ]
en/apm/agent/php/:
product: apm-agent-php
legacy_versions: [ '1.x' ]
en/apm/agent/python/:
product: apm-agent-python
legacy_versions: [ '5.x', '4.x', '3.x', '2.x', '1.x' ]
en/apm/agent/ruby/:
product: apm-agent-ruby
legacy_versions: [ '3.x', '2.x', '1.x' ]
en/apm/agent/rum-js/:
product: apm-agent-rum-js
legacy_versions: [ '4.x', '3.x', '2.x', '1.x', '0.x' ]
en/apm/agent/swift/:
product: apm-agent-ios
legacy_versions: [ '1.2.1', '0.x' ]
en/apm/attacher/:
product: apm-k8s-attacher
legacy_versions: []
en/apm/lambda/:
product: apm-aws-lambda
legacy_versions: []
en/beats/auditbeat/:
product: auditbeat
legacy_versions: *stack
en/beats/devguide/:
product: beats
legacy_versions: *stack
en/beats/filebeat/:
product: filebeat
legacy_versions: *stack
en/beats/functionbeat/:
product: beats
legacy_versions: *stack
en/beats/heartbeat/:
product: heartbeat
legacy_versions: *stack
en/beats/journalbeat/:
product: beats
legacy_versions: *stack
en/beats/libbeat/:
product: beats
legacy_versions: *stack
en/beats/loggingplugin/:
product: beats
legacy_versions: *stack
en/beats/metricbeat/:
product: metricbeat
legacy_versions: *stack
en/beats/packetbeat/:
product: packetbeat
legacy_versions: *stack
en/beats/topbeat/:
product: beats
legacy_versions: *stack
en/beats/winlogbeat/:
product: winlogbeat
legacy_versions: *stack
en/cloud-heroku/:
product: cloud-hosted
legacy_versions: []
en/cloud-on-k8s/:
product: cloud-kubernetes
legacy_versions: [ '3.0+', '2.16', '2.15', '2.14', '2.13', '2.12', '2.11', '2.10', '2.9', '2.8', '2.7', '2.6', '2.5', '2.4', '2.3', '2.2', '2.1', '2.0', '1.9', '1.8', '1.7', '1.6', '1.5', '1.4', '1.3', '1.2', '1.1', '1.0' ]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3.0+ is the current version of eck

en/cloud/:
product: cloud-hosted
legacy_versions: []
en/cloud-enterprise/:
product: cloud-enterprise
legacy_versions: [ '4.0', '3.8', '3.7', '3.6', '3.5', '3.4', '3.3', '3.2', '3.1', '3.0', '2.13', '2.12', '2.11', '2.10', '2.9', '2.8', '2.7', '2.6', '2.5', '2.4', '2.3', '2.2', '2.1', '2.0', '1.1', '1.0' ]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4.0+ is the current version of ece

en/ecctl/:
product: cloud-control-ecctl
legacy_versions: [ '1.14+', '1.13', '1.12', '1.11', '1.10', '1.9', '1.8', '1.7', '1.6', '1.5', '1.4', '1.3', '1.2', '1.1', '1.0' ]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.14+ is the current version of ecctl

en/ecs-logging/:
product: ecs-logging
legacy_versions: []
en/ecs-logging/dotnet/:
product: ecs-dotnet
legacy_versions: []
en/ecs-logging/go-logrus/:
product: ecs-logging-go-logrus
legacy_versions: []
en/ecs-logging/go-zap/:
product: ecs-logging-go-zap
legacy_versions: []
en/ecs-logging/go-zerolog/:
product: ecs-logging-go-zerolog
legacy_versions: []
en/ecs-logging/java/:
product: ecs-logging-java
legacy_versions: ['0.x']
en/ecs-logging/nodejs/:
product: ecs-logging-nodejs
legacy_versions: []
en/ecs-logging/overview/:
product: ecs-logging
legacy_versions: []
en/ecs-logging/php/:
product: ecs-logging-php
legacy_versions: []
en/ecs-logging/python/:
product: ecs-logging-python
legacy_versions: [ '2.2.0' ]
en/ecs-logging/ruby/:
product: ecs-logging-ruby
legacy_versions: []
en/ecs/:
product: ecs
legacy_versions: [ '8.18', '8.17', '8.16', '8.15', '8.14', '8.13', '8.12', '8.11', '8.10', '8.9', '8.8', '8.7', '8.6', '8.5', '8.4', '8.3', '8.2', '8.1', '8.0', '1.12', '1.11', '1.10', '1.9', '1.8', '1.7', '1.6', '1.5', '1.4', '1.3', '1.2', '1.1', '1.0' ]
en/elastic-stack-glossary/:
product: elastic-stack
legacy_versions: []
en/elastic-stack/:
product: elastic-stack
legacy_versions: *stack
en/elasticsearch/client/curator/:
product: curator
legacy_versions: [ '8.0.21', '7.0', '6.0', '5.8', '5.7', '5.6', '5.5', '5.4', '5.3', '5.2', '5.1', '5.0', '4.3', '4.2', '4.1', '4.0', '3.5', '3.4', '3.3' ]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

8.0.21 is current for curator

en/elasticsearch/client/eland/:
product: eland
legacy_versions: []
en/elasticsearch/client/go-api/:
product: elasticsearch
legacy_versions: *stack
en/elasticsearch/client/java-api-client/:
product: elasticsearch
legacy_versions: *stack
en/elasticsearch/client/javascript-api/:
product: elasticsearch
legacy_versions: *stack
en/elasticsearch/client/net-api/:
product: elasticsearch
legacy_versions: *stack
en/elasticsearch/client/php-api/:
product: elasticsearch
legacy_versions: *stack
en/elasticsearch/client/python-api/:
product: elasticsearch
legacy_versions: *stack
en/elasticsearch/client/ruby-api/:
product: elasticsearch
legacy_versions: *stack
en/elasticsearch/client/rust-api/:
product: elasticsearch
legacy_versions: *stack
en/elasticsearch/hadoop/:
product: elasticsearch
legacy_versions: *stack
en/elasticsearch/painless/:
product: elasticsearch
legacy_versions: *stack
en/elasticsearch/plugins/:
product: elasticsearch
legacy_versions: *stack
en/elasticsearch/reference/:
product: elasticsearch
legacy_versions: *stack
en/esf/:
product: elastic-serverless-forwarder
legacy_versions: []
en/fleet/:
product: elastic-agent
legacy_versions: *stack
en/ingest-overview/:
product: elasticsearch
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not elasticsearch

legacy_versions: []
en/ingest/:
product: elasticsearch
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not elasticsearch

legacy_versions: *stack
en/integrations-developer/:
product: integrations
legacy_versions: []
en/integrations/:
product: integrations
legacy_versions: []
en/kibana/:
product: kibana
legacy_versions: *stack
en/logstash-versioned-plugins/:
product: logstash
legacy_versions: []
en/logstash/:
product: logstash
legacy_versions: *stack
en/machine-learning/:
product: elasticsearch
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have a unique product for this although I would argue that it is elasticsearch

legacy_versions: *stack
en/observability/:
product: observability
legacy_versions: *stack
en/reference-architectures/:
product: elasticsearch
legacy_versions: []
en/search-ui/:
product: search-ui
legacy_versions: ['1.24.1', '1.24.0']
en/security/:
product: security
legacy_versions: *stack
en/serverless/:
product: cloud-serverless
legacy_versions: []
en/starting-with-the-elasticsearch-platform-and-its-solutions/:
product: elasticsearch
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not elasticsearch

legacy_versions: *stack
Loading
Loading