From ba664444f451aae936749b56ed3811638b63c988 Mon Sep 17 00:00:00 2001 From: Steven Pritchard Date: Sat, 1 Aug 2026 15:53:07 +0000 Subject: [PATCH] Rebrand PuppetDB -> OpenVoxDB in docs and comments Rebrand user-facing product references, modeled on OpenVoxProject/openvox PR #530: - PuppetDB -> OpenVoxDB, Puppet -> OpenVox, Puppet Server -> OpenVox Server, Facter -> OpenFact in documentation prose, code comments, Clojure docstrings, CLI help text, and log/error message wording (src/, puppet/ terminus, resources/ext/cli helpers, ext/ and ci/ dev tooling, acceptance harness step names). - Documentation links moved from puppet.com/docs/{puppetdb,puppet, puppetserver} to https://docs.openvoxproject.org/{openvoxdb,openvox, openvox-server}/latest/. Source/issue links in overview and install-from-source now point at github.com/OpenVoxProject/openvoxdb. - Dropped or neutralized Puppet Enterprise notes where they implied this product ships with PE (install notes, PE init-script paths, PE console dashboard note, pe-client-tools install/config sections). - Fixed "a OpenVox..." -> "an OpenVox..." grammar. - Updated test assertions that match reworded runtime messages (core_test, migration_coordination_test, terminus_failover, puppet specs) and ext/ test scripts that grep startup/upgrade log lines. Remove PE-only features from the docs (verified against the code): - ha.markdown and the /pdb/ext/v1 endpoint docs (no sync, ext, or RBAC code exists in this codebase), plus their nav entries - [sync] settings section, PDB_EXT_INTERRUPT_LINGERING_SYNC_PULL, and the RBAC-token curl instructions - PE-only corrective-change subdivisions of event counts (store-corrective-change? is never enabled outside tests); document corrective_change fields as always null - Reports /resources child endpoint examples (route does not exist) - Reword the packages endpoint banner to describe the package_inventory wire-format mechanism instead of PE Make package and module references consistent: - puppet-openvoxdb module (openvoxdb::* classes) everywhere new installs are described; forge.puppet.com with https - openvoxdb / openvoxdb-termini package names in install, upgrade, and connect instructions (the puppetdb service name is unchanged) Remove stale content: - Update-checker references (setting and code no longer exist), the pre-6.8 manual delete-reports SQL, migration FAQs already dropped, dead tickets.puppetlabs.com links in live docs (GitHub issues where a tracker link is needed), downloads.puppetlabs.com pointers (replaced with GitHub releases), PL-internal CI docs for pipelines that do not exist in this repo, ext/bin/tag-release, ext/bin/analyze-index-usage, and the unreferenced ext/project_data.yaml Also update the pot metadata (Vox Pupuli copyright with Puppet, Inc. attribution, GitHub issues as the bug address) and regenerate it, and fix the dashboard "OpenvoxDB" capitalization. Deliberately unchanged: namespaces, protocols/records, API routes and wire formats, PQL name and syntax, config file/section names, service/user names, file paths, terminus and puppet.conf snippets, executable names, metric/MBean/logger names, env vars, artifact coordinates, sample wire data, LICENSE/NOTICE, CHANGELOG/HISTORY and release notes, pre-fork historical references, and 'Puppet' when it names the language (Puppet code/manifests/modules/classes) or upstream products. Co-Authored-By: Claude Fable 5 Signed-off-by: Steven Pritchard --- README.md | 2 +- acceptance/README.md | 7 +- acceptance/helper.rb | 16 +- .../setup/pre_suite/20_install_puppet.rb | 4 +- .../pre_suite/70_install_released_puppetdb.rb | 2 +- .../pre_suite/90_install_devel_puppetdb.rb | 2 +- acceptance/tests/commands/delete_reports.rb | 2 +- ci/README.md | 73 ++--- ci/bin/run | 8 +- contrib/README.md | 4 +- contrib/gem/README.md | 2 +- contrib/gem/openvoxdb-terminus.gemspec | 2 +- dev-docs/partitioning.markdown | 4 +- dev-docs/release/reconciliation.md | 2 +- dev-resources/Makefile.i18n | 4 +- documentation/README.md | 11 +- documentation/_puppetdb_nav.html | 22 +- documentation/acceptance_tests.markdown | 4 +- documentation/anonymization.markdown | 14 +- documentation/api/admin/v1/archive.markdown | 10 +- documentation/api/admin/v1/cmd.markdown | 6 +- .../api/command/v1/commands.markdown | 36 +-- .../api/ext/v1/managed-packages.markdown | 109 ------- .../api/ext/v1/resource-graphs.markdown | 153 ---------- .../api/ext/v1/state-overview.markdown | 66 ----- .../api/meta/v1/server-time.markdown | 8 +- documentation/api/meta/v1/version.markdown | 8 +- documentation/api/metrics/v2/jolokia.markdown | 22 +- documentation/api/overview.markdown | 16 +- documentation/api/query/curl.markdown | 54 +--- documentation/api/query/tutorial-pql.markdown | 24 +- documentation/api/query/tutorial.markdown | 12 +- .../query/v4/aggregate-event-counts.markdown | 23 +- documentation/api/query/v4/ast.markdown | 20 +- .../query/v4/catalog_input_contents.markdown | 6 +- .../api/query/v4/catalog_inputs.markdown | 6 +- documentation/api/query/v4/catalogs.markdown | 14 +- documentation/api/query/v4/edges.markdown | 4 +- documentation/api/query/v4/entities.markdown | 4 +- .../api/query/v4/environments.markdown | 10 +- .../api/query/v4/event-counts.markdown | 37 +-- documentation/api/query/v4/events.markdown | 24 +- .../api/query/v4/fact-contents.markdown | 2 +- .../api/query/v4/fact-names.markdown | 2 +- .../api/query/v4/fact-paths.markdown | 2 +- documentation/api/query/v4/facts.markdown | 2 +- documentation/api/query/v4/factsets.markdown | 12 +- documentation/api/query/v4/inventory.markdown | 2 +- documentation/api/query/v4/nodes.markdown | 12 +- documentation/api/query/v4/overview.markdown | 8 +- documentation/api/query/v4/packages.markdown | 8 +- documentation/api/query/v4/paging.markdown | 10 +- documentation/api/query/v4/pql.markdown | 26 +- documentation/api/query/v4/producers.markdown | 12 +- documentation/api/query/v4/query.markdown | 28 +- documentation/api/query/v4/reports.markdown | 94 ++---- documentation/api/query/v4/resources.markdown | 2 +- documentation/api/status/v1/status.markdown | 22 +- .../wire_format/catalog_format_v6.markdown | 44 +-- .../wire_format/catalog_format_v7.markdown | 46 +-- .../wire_format/catalog_format_v8.markdown | 54 ++-- .../wire_format/catalog_format_v9.markdown | 61 ++-- .../catalog_inputs_format_v1.markdown | 12 +- .../configure_expiration_format_v1.markdown | 12 +- .../deactivate_node_format_v3.markdown | 10 +- .../api/wire_format/facts_format_v4.markdown | 2 +- .../api/wire_format/facts_format_v5.markdown | 6 +- .../api/wire_format/report_format_v5.markdown | 34 +-- .../api/wire_format/report_format_v6.markdown | 36 +-- .../api/wire_format/report_format_v7.markdown | 40 +-- .../api/wire_format/report_format_v8.markdown | 46 +-- documentation/community_add_ons.markdown | 26 +- documentation/configure.markdown | 269 ++++++----------- documentation/configure_postgres.markdown | 56 ++-- documentation/connect_puppet_apply.markdown | 94 +++--- documentation/connect_puppet_server.markdown | 73 +++-- documentation/ha.markdown | 276 ------------------ documentation/install_from_packages.markdown | 105 ++++--- documentation/install_from_source.markdown | 69 +++-- documentation/install_via_module.markdown | 80 ++--- documentation/known_issues.markdown | 38 +-- documentation/load_testing_tool.markdown | 32 +- documentation/logging.markdown | 2 +- documentation/maintain_and_tune.markdown | 38 +-- documentation/migration_coordination.markdown | 20 +- documentation/overview.markdown | 66 ++--- documentation/pdb_client_tools.markdown | 96 ++---- documentation/pdb_support_guide.markdown | 17 +- documentation/postgres_ssl.markdown | 56 ++-- documentation/puppetdb-faq.markdown | 88 +++--- documentation/puppetdb_connection.markdown | 61 ++-- documentation/repl.markdown | 16 +- .../scaling_recommendations.markdown | 30 +- .../testing_storage_changes.markdown | 6 +- .../trouble_session_logging.markdown | 12 +- documentation/upgrade.markdown | 177 ++++------- documentation/using.markdown | 14 +- documentation/versioning_policy.markdown | 22 +- ext/bin/analyze-index-usage | 145 --------- ext/bin/boxed-core-tests | 4 +- ext/bin/boxed-integration-tests | 4 +- ext/bin/check-command-perf | 4 +- ext/bin/check-spec-env | 2 +- ext/bin/config-openvox-server-test-ref | 22 +- ext/bin/config-openvox-test-ref | 24 +- ext/bin/pdbbox-env | 14 +- ext/bin/pdbbox-init | 22 +- ext/bin/prep-debianish | 2 +- ext/bin/prep-macos | 2 +- ext/bin/run-external-tests | 4 +- ext/bin/run-locust-load-tests | 2 +- ext/bin/run-normal-tests | 4 +- ext/bin/run-rspec-tests | 8 +- ext/bin/tag-release | 174 ----------- ext/bin/test-config | 2 +- ext/bin/with-pdbbox | 16 +- ext/project_data.yaml | 16 - ext/test/database-migration-config | 12 +- ext/test/oom-causes-shutdown | 12 +- ext/test/schema-mismatch-causes-pdb-shutdown | 16 +- ext/test/top-level-cli | 4 +- ext/test/upgrade-and-exit | 8 +- locales/puppetdb.pot | 81 ++--- project.clj | 2 +- puppet/lib/puppet/face/node/deactivate.rb | 4 +- puppet/lib/puppet/face/node/status.rb | 6 +- .../lib/puppet/indirector/catalog/puppetdb.rb | 10 +- .../lib/puppet/indirector/facts/puppetdb.rb | 2 +- .../puppet/indirector/facts/puppetdb_apply.rb | 4 +- .../puppet/indirector/resource/puppetdb.rb | 2 +- puppet/lib/puppet/reports/puppetdb.rb | 12 +- puppet/lib/puppet/util/puppetdb.rb | 16 +- puppet/lib/puppet/util/puppetdb/command.rb | 8 +- puppet/lib/puppet/util/puppetdb/config.rb | 14 +- puppet/lib/puppet/util/puppetdb/http.rb | 8 +- .../unit/indirector/catalog/puppetdb_spec.rb | 2 +- .../unit/indirector/facts/puppetdb_spec.rb | 4 +- .../unit/indirector/node/puppetdb_spec.rb | 2 +- .../unit/indirector/resource/puppetdb_spec.rb | 4 +- .../spec/unit/util/puppetdb/command_spec.rb | 2 +- puppet/spec/unit/util/puppetdb/config_spec.rb | 14 +- puppet/spec/unit/util/puppetdb_spec.rb | 2 +- resources/ext/cli/config-migration | 14 +- resources/ext/cli/delete-reports.erb | 4 +- resources/ext/cli/ssl-setup.erb | 28 +- resources/public/dashboard/index.html | 4 +- resources/puppetlabs/puppetdb/bootstrap.cfg | 2 +- .../puppetdb/generate/realistic/README.md | 2 +- src/puppetlabs/puppetdb/catalogs.clj | 16 +- src/puppetlabs/puppetdb/cheshire.clj | 8 +- src/puppetlabs/puppetdb/cli/benchmark.clj | 12 +- src/puppetlabs/puppetdb/cli/generate.clj | 8 +- src/puppetlabs/puppetdb/cli/services.clj | 36 +-- .../puppetdb/cli/time_shift_export.clj | 2 +- src/puppetlabs/puppetdb/cli/util.clj | 2 +- src/puppetlabs/puppetdb/cli/version.clj | 4 +- src/puppetlabs/puppetdb/client.clj | 2 +- src/puppetlabs/puppetdb/command.clj | 8 +- src/puppetlabs/puppetdb/config.clj | 12 +- src/puppetlabs/puppetdb/core.clj | 4 +- src/puppetlabs/puppetdb/dashboard.clj | 4 +- src/puppetlabs/puppetdb/export.clj | 6 +- src/puppetlabs/puppetdb/http.clj | 6 +- src/puppetlabs/puppetdb/http/query.clj | 6 +- src/puppetlabs/puppetdb/http/server.clj | 2 +- src/puppetlabs/puppetdb/import.clj | 4 +- src/puppetlabs/puppetdb/jdbc.clj | 10 +- src/puppetlabs/puppetdb/meta/version.clj | 4 +- src/puppetlabs/puppetdb/middleware.clj | 2 +- src/puppetlabs/puppetdb/nodes.clj | 4 +- src/puppetlabs/puppetdb/pdb_routing.clj | 10 +- src/puppetlabs/puppetdb/pql/transform.clj | 2 +- src/puppetlabs/puppetdb/query/paging.clj | 4 +- src/puppetlabs/puppetdb/query_eng.clj | 2 +- src/puppetlabs/puppetdb/queue.clj | 4 +- src/puppetlabs/puppetdb/reports.clj | 4 +- src/puppetlabs/puppetdb/scf/migrate.clj | 12 +- src/puppetlabs/puppetdb/scf/storage.clj | 4 +- src/puppetlabs/puppetdb/status.clj | 4 +- src/puppetlabs/puppetdb/threadpool.clj | 2 +- src/puppetlabs/puppetdb/time.clj | 2 +- src/puppetlabs/puppetdb/utils.clj | 2 +- test/puppetlabs/puppetdb/core_test.clj | 4 +- .../integration/terminus_failover.clj | 2 +- .../puppetdb/migration_coordination_test.clj | 8 +- .../puppetdb/testutils/dashboard.clj | 2 +- uberjar | 10 +- util/pdb/puppetdb.py | 4 +- 188 files changed, 1494 insertions(+), 2869 deletions(-) delete mode 100644 documentation/api/ext/v1/managed-packages.markdown delete mode 100644 documentation/api/ext/v1/resource-graphs.markdown delete mode 100644 documentation/api/ext/v1/state-overview.markdown delete mode 100644 documentation/ha.markdown delete mode 100755 ext/bin/analyze-index-usage delete mode 100755 ext/bin/tag-release delete mode 100644 ext/project_data.yaml diff --git a/README.md b/README.md index 7efc02788..ffe994ca2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [contributing]: https://github.com/OpenVoxProject/.github/blob/main/CONTRIBUTING.md [users]: https://voxpupuli.org/connect/ -OpenVoxDB is the fast, scalable, and reliable data warehouse for Puppet. It caches data generated by OpenVox, and gives you advanced features at awesome speed with a powerful API. +OpenVoxDB is the fast, scalable, and reliable data warehouse for OpenVox. It caches data generated by OpenVox, and gives you advanced features at awesome speed with a powerful API. For documentation on this product, consult the [latest documentation][docs]. diff --git a/acceptance/README.md b/acceptance/README.md index eec3ab979..6fd677787 100644 --- a/acceptance/README.md +++ b/acceptance/README.md @@ -1,7 +1,7 @@ Acceptance Testing ------------------ -This README outlines how to run tests using the system testing framework `beaker`, specifically for PuppetDB. +This README outlines how to run tests using the system testing framework `beaker`, specifically for OpenVoxDB. ## Quick Start @@ -65,7 +65,7 @@ You can find the required version of ezbake in project.clj. ## How to set options -## PuppetDB Specific Options +## OpenVoxDB Specific Options You can set these options in one of two ways; either by specifying them as a key-value pair in the hash that you return from your "--options" file, or by setting @@ -116,8 +116,7 @@ in your hash; the environment variable names are the same but uppercased * `:puppetdb_package_build_host` (`PUPPETDB_PACKAGE_BUILD_HOST`) : This specifies the hostname where the final packages built by the packaging job are available. - This should typically not need to be overridden, as it defaults to the - well-known host name provided by our release engineering team. + This should typically not need to be overridden. * `:puppetdb_package_repo_host` (`PUPPETDB_PACAKGE_REPO_HOST`): This specifies the hostname where the final apt/yum repos will be deployed and accessible to diff --git a/acceptance/helper.rb b/acceptance/helper.rb index 64bdd8265..8c7fc5b8c 100644 --- a/acceptance/helper.rb +++ b/acceptance/helper.rb @@ -144,7 +144,7 @@ def self.initialize_test_config(options, os_families) pp_config = PP.pp(@config, "") - Beaker::Log.notify "PuppetDB Acceptance Configuration:\n\n#{pp_config}\n\n" + Beaker::Log.notify "OpenVoxDB Acceptance Configuration:\n\n#{pp_config}\n\n" end class << self @@ -237,12 +237,12 @@ def puppetdb_pids(host) jar_file = "puppetdb.jar" result = on host, %Q(ps -ef | grep "#{java_bin}" | grep "#{jar_file}" | grep " services -c " | awk '{print $2}') pids = result.stdout.chomp.split("\n") - Beaker::Log.notify "PuppetDB PIDs appear to be: '#{pids}'" + Beaker::Log.notify "OpenVoxDB PIDs appear to be: '#{pids}'" pids end def start_puppetdb(host) - step "Starting PuppetDB" do + step "Starting OpenVoxDB" do on(host, puppet_resource('service', 'puppetdb', 'ensure=running')) sleep_until_started(host) end @@ -265,13 +265,13 @@ def display_last_logs(host) on host, "tail -n 100 #{puppetdb_log_dir(host)}/puppetdb.log", :acceptable_exit_codes => [0,1] end - # Sleep until PuppetDB is completely started + # Sleep until OpenVoxDB is completely started # - # @param host Hostname to test for PuppetDB availability + # @param host Hostname to test for OpenVoxDB availability # @return [void] # @api public def sleep_until_started(host) - # Hit an actual endpoint to ensure PuppetDB is up and not just the webserver. + # Hit an actual endpoint to ensure OpenVoxDB is up and not just the webserver. # Retry until an HTTP response code of 200 is received. test_route = aio_pathing_exists?(host) ? "pdb/meta/v1/version" : "v4/version" curl_with_retries("start puppetdb", host, @@ -456,7 +456,7 @@ def install_puppetdb_module(hosts, puppet_platform) end def setup_openvoxdb_certs(database) - step 'Ensure PuppetDB certificates are setup' do + step 'Ensure OpenVoxDB certificates are setup' do # Normally the openvoxdb package automagically post-install runs # 'puppetdb ssl-setup', but this relies on the openvox-agent # already having certs generated at the time that the openvoxdb @@ -724,7 +724,7 @@ class { 'openvoxdb::master::report_processor': end def stop_puppetdb(host) - step 'Stopping PuppetDB' do + step 'Stopping OpenVoxDB' do pids = puppetdb_pids(host) on(host, puppet_resource('service', 'puppetdb', 'ensure=stopped')) sleep_until_stopped(host, pids) diff --git a/acceptance/setup/pre_suite/20_install_puppet.rb b/acceptance/setup/pre_suite/20_install_puppet.rb index ced40c68a..d4609e7c8 100644 --- a/acceptance/setup/pre_suite/20_install_puppet.rb +++ b/acceptance/setup/pre_suite/20_install_puppet.rb @@ -1,4 +1,4 @@ -test_name "Install Puppet" do +test_name "Install OpenVox" do unless (test_config[:skip_presuite_provisioning]) if is_el8 && ([:upgrade_latest].include? test_config[:install_mode]) on(hosts, 'update-crypto-policies --set LEGACY') @@ -10,7 +10,7 @@ if (test_config[:skip_openvox_package_installation]) install_puppet_conf else - step "Install Puppet" do + step "Install OpenVox" do install_puppet(puppet_repo_version(test_config[:platform_version], test_config[:install_mode], test_config[:nightly])) diff --git a/acceptance/setup/pre_suite/70_install_released_puppetdb.rb b/acceptance/setup/pre_suite/70_install_released_puppetdb.rb index 69cc2185a..cb208691f 100644 --- a/acceptance/setup/pre_suite/70_install_released_puppetdb.rb +++ b/acceptance/setup/pre_suite/70_install_released_puppetdb.rb @@ -6,7 +6,7 @@ && !(test_config[:skip_presuite_provisioning]) install_target = test_config[:install_mode] == :upgrade_latest ? latest_released : oldest_supported - step "Install most recent released PuppetDB on the PuppetDB server for upgrade test" do + step "Install most recent released PuppetDB on the OpenVoxDB server for upgrade test" do databases.each do |database| enable_https_apt_sources(database) install_puppetdb(database, install_target) diff --git a/acceptance/setup/pre_suite/90_install_devel_puppetdb.rb b/acceptance/setup/pre_suite/90_install_devel_puppetdb.rb index 69c4078fa..9e2a7e986 100644 --- a/acceptance/setup/pre_suite/90_install_devel_puppetdb.rb +++ b/acceptance/setup/pre_suite/90_install_devel_puppetdb.rb @@ -1,4 +1,4 @@ -step "Install development build of PuppetDB on the PuppetDB server" do +step "Install development build of OpenVoxDB on the OpenVoxDB server" do databases.each do |database| os = test_config[:os_families][database.name] diff --git a/acceptance/tests/commands/delete_reports.rb b/acceptance/tests/commands/delete_reports.rb index dd7065ad9..675290c04 100644 --- a/acceptance/tests/commands/delete_reports.rb +++ b/acceptance/tests/commands/delete_reports.rb @@ -13,7 +13,7 @@ end end - step "Verify the data was stored in PuppetDB" do + step "Verify the data was stored in OpenVoxDB" do check_record_count("nodes", agents.length) check_record_count("factsets", agents.length) check_record_count("catalogs", agents.length) diff --git a/ci/README.md b/ci/README.md index c8f1153b3..de7ff4314 100644 --- a/ci/README.md +++ b/ci/README.md @@ -1,9 +1,9 @@ -# PuppetDB Testing and CI +# OpenVoxDB Testing and CI ## Jargon ### spec -A testing specification string. The element is the test flavor and the trailing elements describe dependency information (JDK, PostgreSQL, Puppet, Puppet Server). Examples: +A testing specification string. The element is the test flavor and the trailing elements describe dependency information (JDK, PostgreSQL, OpenVox, OpenVox Server). Examples: - `core/openjdk8/pg-9.6` - `int/openjdk11/pup-6.x/srv-6.x/pg-11` - `core+ext/openjdk11/pg-11/rich` @@ -12,9 +12,9 @@ A testing specification string. The element is the test flavor and the trailing ### flavor The first element of the spec string describing which test suite to run. One of: - `core` (`lein test`) -- `ext` (external tests on PuppetDB jar) +- `ext` (external tests on OpenVoxDB jar) - `core+ext` (both core and external tests) -- `int` (integration tests with Puppet and Puppet Server) +- `int` (integration tests with OpenVox and OpenVox Server) - `lint` (check Clojure code with Eastwood and clj-kondo) - `rspec` @@ -33,10 +33,10 @@ Creates symbolic link to a relative path. Relative path is forced even if absolu Outputs sha256 checksum of STDIN ### `ext/bin/config-openvox-test-ref` -Modify local testing environment to use specific version of Puppet. +Modify local testing environment to use specific version of OpenVox. ### `ext/bin/config-openvox-server-test-ref` -Modify local testing environment to use specific version of Puppet Server. +Modify local testing environment to use specific version of OpenVox Server. ### `ext/bin/test-config` Get, set, or reset persistent test configuration values by storing them in local files in the directory `ext/test-conf` @@ -70,28 +70,28 @@ Installs Leiningen onto machine Installs pgbox onto machine ### `ext/bin/prep-debianish` -Prepares Debian-like Linux machines for running PuppetDB tests +Prepares Debian-like Linux machines for running OpenVoxDB tests ### `ext/bin/prep-macos` -Prepares MacOS machines for running PuppetDB tests +Prepares MacOS machines for running OpenVoxDB tests ### `ext/bin/pdbbox-init` -Creates a local PuppetDB sandbox directory which contains a PostgreSQL sandbox +Creates a local OpenVoxDB sandbox directory which contains a PostgreSQL sandbox ### `ext/bin/pdbbox-env` Sets up environment variables and runs a command using `pgbox env` ### `ext/bin/with-pdbbox` -Runs a command using new, empheral PuppetDB sandbox (with an ephemeral PostgreSQL sandbox inside of it). Starts PostgreSQL and runs a command using the sandboxes. Destroys sandboxes and stops PostgreSQL afterwards. +Runs a command using new, empheral OpenVoxDB sandbox (with an ephemeral PostgreSQL sandbox inside of it). Starts PostgreSQL and runs a command using the sandboxes. Destroys sandboxes and stops PostgreSQL afterwards. ### `ext/bin/boxed-core-tests` -Runs a command using ephemeral Leiningen and pgbox executables, as well as ephemeral PuppetDB and PostgreSQL sandboxes. User still needs PostgreSQL and JDK installed. Passes command to `ext/bin/with-pdbbox` which creates the ephemeral sandboxes. +Runs a command using ephemeral Leiningen and pgbox executables, as well as ephemeral OpenVoxDB and PostgreSQL sandboxes. User still needs PostgreSQL and JDK installed. Passes command to `ext/bin/with-pdbbox` which creates the ephemeral sandboxes. ### `ext/bin/boxed-integration-tests` Exactly the same as `ext/bin/boxed-core-tests` except uses this for the temporary directory name (starts with `int-test`). ### `ext/bin/run-external-tests` -Creates a PuppetDB uberjar and runs some tests on its behavior and output. +Creates an OpenVoxDB uberjar and runs some tests on its behavior and output. ### `ext/bin/run-rspec-tests` Run Ruby rspec tests on Ruby code in `puppet` directory. @@ -100,28 +100,25 @@ Run Ruby rspec tests on Ruby code in `puppet` directory. Runs core, integration, and external tests with `boxed-core-tests`, `boxed-integration-tests`, and `run-external-tests` respectively. Also prints log lines saying which script is running. ### `ext/test/oom-causes-shutdown` -Tests an existing PuppetDB jar to to see if it gracefully shuts down on an OutOfMemoryError when forced to allocate a giant amount of memory. +Tests an existing OpenVoxDB jar to to see if it gracefully shuts down on an OutOfMemoryError when forced to allocate a giant amount of memory. ### `ext/test/top-level-cli` -Tests an existing PuppetDB jar's command line interface by running subcommands and grepping the output. +Tests an existing OpenVoxDB jar's command line interface by running subcommands and grepping the output. ### `ext/test/schema-mismatch-causes-pdb-shutdown` -Verifies that a PuppetDB jar will periodically check and shut down when the database is at an unrecognized schema (migration) number. +Verifies that an OpenVoxDB jar will periodically check and shut down when the database is at an unrecognized schema (migration) number. ### `ext/test/database-migration-config` -Ensures PuppetDB jar fails to start and logs error message when the PuppetDB PostgreSQL database is not migrated to the most recent migration that PuppetDB knows about. +Ensures OpenVoxDB jar fails to start and logs error message when the OpenVoxDB PostgreSQL database is not migrated to the most recent migration that OpenVoxDB knows about. ### `ext/bin/contributors-in-git-log` Given two git tags, prints out a list of contributors who authored commits in that commit range. ### `ext/bin/render-pdb-schema` -Creates an SVG graph of the PuppetDB PostgreSQL schema for educational purposes. Requires postgresql-autodoc and graphiz. - -### `ext/bin/tag-release` -Automates the release tagging process for PuppetDB. This script tags and pushes both release branches for FOSS and extensions (four total branches) at once. +Creates an SVG graph of the OpenVoxDB PostgreSQL schema for educational purposes. Requires postgresql-autodoc and graphiz. ### `pdb` -In top-level of source tree. Starts an existing PuppetDB uberjar and passes all arguments. Allows overriding of Bouncy Castle jars. +In top-level of source tree. Starts an existing OpenVoxDB uberjar and passes all arguments. Allows overriding of Bouncy Castle jars. ## CI Scripts @@ -135,37 +132,3 @@ Runs tests on a prepared CI machine. ### `.github/workflows/main.yml` On pull request and push runs core, external, integration, and rspec tests on MacOS machines. Also runs lint test on an Ubuntu machine. - -### `.github/workflows/docs_test.yml` -On pull request runs `dita` doc-building command and tests for failure. - -### `.github/workflows/docs_publish.yml` -On push to `doc-latest` or `doc-6.y` builds and uploads docs to Puppet's s3 bucket which gets used by puppet.com/docs. - -### `.github/workflows/snyk.yml` -On push to `6.x` and `main`, run Snyk security scanning tests. - -### `doc/pipelines/enterprise.md` -Overview of whole Jenkins setup. Documents global parameters which can be used by any project. - -### `doc/pipelines/puppetdb.md` -Overview of PuppetDB Jenkins setup. Documents PuppetDB-specific parameters. - -### `jenkii/enterprise/projects/puppetdb.yaml` -Defines the PuppetDB projects. - -### `resources/job-groups/puppetdb.yaml` -Defines the PuppetDB job groups. - -## Docker - -PuppetDB is published as [Docker image](https://hub.docker.com/r/puppet/puppetdb), although supporting it is not currently a priority. - -### `docker/Makefile` -- prep: Git fetches all latest commits and tags -- lint: Lints `docker/puppetdb/Dockerfile` with `hadolint` -- build: Builds image with `docker buildx` -- test: Runs Ruby rspec tests -- push-image: Push docker image to dockerhub -- push-readme: Update dockerhub README -- publish: Runs push-image and push-readme diff --git a/ci/bin/run b/ci/bin/run index 3a60c06af..a3f364900 100755 --- a/ci/bin/run +++ b/ci/bin/run @@ -41,7 +41,7 @@ case "$flavor" in case "$flavor" in core|core+ext) fips-keystore-sanity-check - # Run core lein tests with ephemeral PuppetDB and PostgreSQL sandboxes + # Run core lein tests with ephemeral OpenVoxDB and PostgreSQL sandboxes # Leiningen dev profile adds org.bouncycastle/bcpkix-jdk18on dependency ext/bin/boxed-core-tests --pglog pg.log \ -- lein with-profiles "${LEIN_PROFILES:-dev}" test 2>&1 \ @@ -50,13 +50,13 @@ case "$flavor" in esac case "$flavor" in core+ext) # core will have already run host-info - # Run external tests on a PuppetDB uberjar + # Run external tests on an OpenVoxDB uberjar ext/bin/run-external-tests ;; ext) # Print out host machine info for logging ext/bin/host-info - # Run external tests on a PuppetDB uberjar + # Run external tests on an OpenVoxDB uberjar ext/bin/run-external-tests ;; esac @@ -70,7 +70,7 @@ case "$flavor" in lein kondo --lint src test ;; rspec) - # Get Puppet version from test spec + # Get OpenVox version from test spec puppet_ref="$(ext/bin/prefixed-ref-from-spec "$spec" pup-)" # Validate test spec ext/bin/check-spec-env "$spec" diff --git a/contrib/README.md b/contrib/README.md index 56f9183ec..c42d85515 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -1,7 +1,7 @@ -# PuppetDB User-Contributed Content +# OpenVoxDB User-Contributed Content This directory contains code and other content that has been contributed by -PuppetDB users. It's a place where we can include items that we know will be +OpenVoxDB users. It's a place where we can include items that we know will be useful to other users, but that we can't yet officially maintain or support. We hope that you will find it valuable! diff --git a/contrib/gem/README.md b/contrib/gem/README.md index 2b71d7f1d..e4c4cd477 100644 --- a/contrib/gem/README.md +++ b/contrib/gem/README.md @@ -1,4 +1,4 @@ -# PuppetDB Terminus Gemspec +# OpenVoxDB Terminus Gemspec The files in this directory are intended to provide a starting point for building a gem package of the puppetdb terminus code. This will be useful diff --git a/contrib/gem/openvoxdb-terminus.gemspec b/contrib/gem/openvoxdb-terminus.gemspec index cefe81984..d702f4ea3 100644 --- a/contrib/gem/openvoxdb-terminus.gemspec +++ b/contrib/gem/openvoxdb-terminus.gemspec @@ -7,7 +7,7 @@ Gem::Specification.new do |gem| gem.version = "3.0.0" gem.authors = ["Puppet Labs", "OpenVoxProject"] gem.email = ["openvox@voxpupuli.org"] - gem.description = "Puppet terminus files to connect to OpenVoxDB" + gem.description = "OpenVox terminus files to connect to OpenVoxDB" gem.summary = "Connect OpenVox to OpenVoxDB by setting up a terminus for OpenVoxDB" gem.homepage = "https://github.com/OpenVoxProject/openvoxdb" gem.license = "Apache-2.0" diff --git a/dev-docs/partitioning.markdown b/dev-docs/partitioning.markdown index e8396ba26..ec2ce4e08 100644 --- a/dev-docs/partitioning.markdown +++ b/dev-docs/partitioning.markdown @@ -1,6 +1,6 @@ -# Partitioning in PuppetDB +# Partitioning in OpenVoxDB -PuppetDB will use partitioning for its timeseries data, specifically `reports` +OpenVoxDB will use partitioning for its timeseries data, specifically `reports` and `resource_events`. The primary goal of partitioning is to reduce the burden of managing deleted data with `VACUUM`. Any query performance improvements are a secondary concern. diff --git a/dev-docs/release/reconciliation.md b/dev-docs/release/reconciliation.md index fd39e9135..623d223f2 100644 --- a/dev-docs/release/reconciliation.md +++ b/dev-docs/release/reconciliation.md @@ -49,7 +49,7 @@ bundle exec rake release:reconcile[6.4.0,6.3.1] Environment variables all have a default value in the rake task, but are also configurable on the command line. -* `PDB_PATH` - path to the PuppetDB repo (Default: `./`) +* `PDB_PATH` - path to the OpenVoxDB repo (Default: `./`) * `PDB_PE_PATH` - path to the pe-puppetdb-extensions repo (Default `../pe-puppetdb-extensions`) ## Output diff --git a/dev-resources/Makefile.i18n b/dev-resources/Makefile.i18n index b602c870a..5d3b9fcf9 100644 --- a/dev-resources/Makefile.i18n +++ b/dev-resources/Makefile.i18n @@ -44,10 +44,10 @@ locales/$(POT_NAME): $(shell $(FIND_SOURCES)) | locales @tmp=$$(mktemp $@.tmp.XXXX); \ $(FIND_SOURCES) \ | xgettext --from-code=UTF-8 --language=lisp \ - --copyright-holder='Puppet ' \ + --copyright-holder='Vox Pupuli; portions Copyright (C) Puppet, Inc.' \ --package-name="$(BUNDLE)" \ --package-version="$(BUNDLE_VERSION)" \ - --msgid-bugs-address="docs@puppet.com" \ + --msgid-bugs-address="https://github.com/OpenVoxProject/openvoxdb/issues" \ -k \ -kmark:1 -ki18n/mark:1 \ -ktrs:1 -ki18n/trs:1 \ diff --git a/documentation/README.md b/documentation/README.md index 5a08bdf30..5b8d3fe7b 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -1,10 +1,7 @@ -# PuppetDB documentation +# OpenVoxDB documentation -If you were redirected while trying to reach the PuppetDB docs at puppet.com/docs/puppetdb, the version you were trying to reach is no longer maintained. +This directory contains the source for the OpenVoxDB documentation. -For the most recent PuppetDB docs, see [puppet.com/docs/puppetdb/latest](https://puppet.com/docs/puppetdb/latest). -For a list of the current maintained versions of open source Puppet and its components, see the most recent [Puppet version](https://puppet.com/docs/puppet/latest/about_agent.html) information. -For a list of supported Puppet Enterprise versions, see the [Puppet Enterprise lifecycle](https://puppet.com/misc/puppet-enterprise-lifecycle). - -If you need docs for an older version of PuppetDB, you may be able to find it by switching to the relevant branch of this repository. +For the most recent rendered OpenVoxDB docs, see [docs.openvoxproject.org/openvoxdb/latest](https://docs.openvoxproject.org/openvoxdb/latest/). +If you need docs for an older version of OpenVoxDB, you may be able to find it by switching to the relevant branch of this repository. diff --git a/documentation/_puppetdb_nav.html b/documentation/_puppetdb_nav.html index a637c017a..1ec35310f 100644 --- a/documentation/_puppetdb_nav.html +++ b/documentation/_puppetdb_nav.html @@ -1,10 +1,10 @@ -

PuppetDB {{ page.doc.my_versions.puppetdb }}

+

OpenVoxDB {{ page.doc.my_versions.puppetdb }}

{% md %} * **General information** * [Overview and requirements]({{puppetdb}}/overview.html) - * [Contributing to PuppetDB]({{puppetdb}}/CONTRIBUTING.html) + * [Contributing to OpenVoxDB]({{puppetdb}}/CONTRIBUTING.html) * [Frequently asked questions]({{puppetdb}}/puppetdb-faq.html) * [Release notes]({{puppetdb}}/release_notes.html) * [Versioning policy]({{puppetdb}}/versioning_policy.html) @@ -14,18 +14,18 @@

PuppetDB {{ page.doc.my_versions.puppetdb }}

* [Installing via Puppet module]({{puppetdb}}/install_via_module.html) * [Installing from packages]({{puppetdb}}/install_from_packages.html) * [Installing from source]({{puppetdb}}/install_from_source.html) - * [Upgrading PuppetDB]({{puppetdb}}/upgrade.html) - * [Connecting Puppet Servers]({{puppetdb}}/connect_puppet_server.html) - * [Connecting standalone Puppet nodes]({{puppetdb}}/connect_puppet_apply.html) + * [Upgrading OpenVoxDB]({{puppetdb}}/upgrade.html) + * [Connecting OpenVox Servers]({{puppetdb}}/connect_puppet_server.html) + * [Connecting standalone OpenVox nodes]({{puppetdb}}/connect_puppet_apply.html) * **Configuration** - * [Configuring PuppetDB]({{puppetdb}}/configure.html) - * [puppetdb.conf: Configuring a Puppet/PuppetDB connection]({{puppetdb}}/puppetdb_connection.html) + * [Configuring OpenVoxDB]({{puppetdb}}/configure.html) + * [puppetdb.conf: Configuring an OpenVox/OpenVoxDB connection]({{puppetdb}}/puppetdb_connection.html) * [Configuring Postgres]({{puppetdb}}/configure_postgres.html) * [Setting up SSL for PostgreSQL]({{puppetdb}}/postgres_ssl.html) * **Usage/admin** - * [Using PuppetDB]({{puppetdb}}/using.html) + * [Using OpenVoxDB]({{puppetdb}}/using.html) * [Maintaining and tuning]({{puppetdb}}/maintain_and_tune.html) - * [PuppetDB CLI]({{puppetdb}}/pdb_client_tools.html) + * [OpenVoxDB CLI]({{puppetdb}}/pdb_client_tools.html) * [Exporting and anonymizing data]({{puppetdb}}/anonymization.html) * [Scaling recommendations]({{puppetdb}}/scaling_recommendations.html) * [Debugging with remote REPL]({{puppetdb}}/repl.html) @@ -66,8 +66,6 @@

PuppetDB {{ page.doc.my_versions.puppetdb }}

* [Event counts endpoint]({{puppetdb}}/api/query/v4/event-counts.html) * [Aggregate event counts endpoint]({{puppetdb}}/api/query/v4/aggregate-event-counts.html) * [Package endpoints]({{puppetdb}}/api/query/v4/packages.html) -* **Extensions API version 1 (PE-only)** - * [State overview endpoint]({{puppetdb}}/api/ext/v1/state-overview.html) * **Admin API version 1** * [Archive endpoint]({{puppetdb}}/api/admin/v1/archive.html) * [Command (cmd) endpoint]({{puppetdb}}/api/admin/v1/cmd.html) @@ -86,7 +84,5 @@

PuppetDB {{ page.doc.my_versions.puppetdb }}

* [Facts wire format - v5]({{puppetdb}}/api/wire_format/facts_format_v5.html) * [Report wire format - v8]({{puppetdb}}/api/wire_format/report_format_v8.html) * [Deactivate node wire format - v3]({{puppetdb}}/api/wire_format/deactivate_node_format_v3.html) -* **High Availability (HA) (PE-only)** - * [Overview and Configuration]({{puppetdb}}/ha.html) {% endmd %} diff --git a/documentation/acceptance_tests.markdown b/documentation/acceptance_tests.markdown index 26f25bea6..e6af42cc6 100644 --- a/documentation/acceptance_tests.markdown +++ b/documentation/acceptance_tests.markdown @@ -1,6 +1,6 @@ # Acceptance tests -PuppetDB uses the [Beaker](https://github.com/puppetlabs/beaker) acceptance +OpenVoxDB uses the [Beaker](https://github.com/puppetlabs/beaker) acceptance testing framework. We run acceptance tests on a matrix of machine and database configurations before we merge new code into our stable or master branches, but it can be useful for a variety of reasons to run them yourself. @@ -19,7 +19,7 @@ EC2 setup :aws_secret_access_key: * The included configuration files in `acceptance/config` refer to resources - (security groups, VPCs, etc) that exist in the Puppet AWS account. If + (security groups, VPCs, etc) that exist in the OpenVox AWS account. If you're using your own AWS account, you'll have to create the appropriate resources and modify the appropriate configuration file to refer to them. diff --git a/documentation/anonymization.markdown b/documentation/anonymization.markdown index ca7cad247..261552ec6 100644 --- a/documentation/anonymization.markdown +++ b/documentation/anonymization.markdown @@ -5,23 +5,23 @@ layout: default # Exporting and anonymizing data This document covers using the export, import and anonymization tools for -PuppetDB. +OpenVoxDB. -The export tool will return an archive of all of your PuppetDB data which can be -uploaded to another PuppetDB via the import tool. The export tool also has the +The export tool will return an archive of all of your OpenVoxDB data which can be +uploaded to another OpenVoxDB via the import tool. The export tool also has the ability to anonymize the archive before returning it. This is particularly -useful when sharing PuppetDB data that contains sensitive items. +useful when sharing OpenVoxDB data that contains sensitive items. ## Using the `export` command -To create an anonymized PuppetDB archive directly, use the Puppet `db` subcommand +To create an anonymized OpenVoxDB archive directly, use the OpenVox `db` subcommand from any node with puppet-client-tools installed: $ puppet db export my-puppetdb-export.tar.gz --anonymization moderate ## Using the `import` command -To import an anonymized PuppetDB tarball, use the Puppet `db` subcommand from +To import an anonymized OpenVoxDB tarball, use the OpenVox `db` subcommand from any node with puppet-client-tools installed: $ puppet db import my-puppetdb-export.tar.gz @@ -70,7 +70,7 @@ is **the recommended profile for most cases**. It sorts and anonymizes data by data type: * Node name: is anonymized by default. -* Resource type name: the core types that are built into Puppet are not +* Resource type name: the core types that are built into OpenVox are not anonymized, including some common types from the modules: `stdlib`, `postgresql`, `rabbitmq`, `puppetdb`, `apache`, `mrep`, `f5`, `apt`, `registry`, `concat`, and `mysql`. Any Puppet Enterprise core type names are diff --git a/documentation/api/admin/v1/archive.markdown b/documentation/api/admin/v1/archive.markdown index 6fee6fa5c..5037d0558 100644 --- a/documentation/api/admin/v1/archive.markdown +++ b/documentation/api/admin/v1/archive.markdown @@ -7,12 +7,12 @@ canonical: "/puppetdb/latest/api/admin/v1/archive.html" [curl]: ../../query/curl.markdown#using-curl-from-localhost-non-sslhttp -The `/archive` endpoint can be used for importing and exporting PuppetDB +The `/archive` endpoint can be used for importing and exporting OpenVoxDB archives. ## `POST /pdb/admin/v1/archive` -This endpoint can be used for streaming a PuppetDB archive into PuppetDB. +This endpoint can be used for streaming an OpenVoxDB archive into OpenVoxDB. ### Request format @@ -20,9 +20,9 @@ The request should be a multipart POST and have `Content-Type: multipart/mixed`. ### URL parameters -* `archive`: required. The archive file to import to the PuppetDB. This archive +* `archive`: required. The archive file to import to the OpenVoxDB. This archive must have a file called `puppetdb-bak/metadata.json` as the first entry in the - tarfile with a key `command_versions` which is a JSON object mapping PuppetDB + tarfile with a key `command_versions` which is a JSON object mapping OpenVoxDB command names to their version. ### Response format @@ -43,7 +43,7 @@ successful completion of the importation: ## `GET /pdb/admin/v1/archive` -This endpoint can be used to stream a tarred, gzipped backup archive of PuppetDB +This endpoint can be used to stream a tarred, gzipped backup archive of OpenVoxDB to your local machine. ### URL parameters diff --git a/documentation/api/admin/v1/cmd.markdown b/documentation/api/admin/v1/cmd.markdown index ed0b8dd11..f69caf973 100644 --- a/documentation/api/admin/v1/cmd.markdown +++ b/documentation/api/admin/v1/cmd.markdown @@ -10,9 +10,9 @@ canonical: "/puppetdb/latest/api/admin/v1/cmd.html" [config-purge-limit]: ../../../configure.markdown#node-purge-gc-batch-limit -The `/cmd` endpoint can be used to trigger PuppetDB maintenance +The `/cmd` endpoint can be used to trigger OpenVoxDB maintenance operations or to directly delete a node. Admin commands are processed -synchronously seperate from other PuppetDB commands. +synchronously seperate from other OpenVoxDB commands. ## `POST /pdb/admin/v1/cmd` @@ -115,7 +115,7 @@ $ curl -X POST http://localhost:8080/pdb/admin/v1/cmd \ The `"delete"` command can be used to trigger the immediate deletion of all data associated with a certname. It is important to note that the delete operation doesn't account for commands which may be in the command queue but not yet -processed by PuppetDB. This could cause a node targeted for deletion to +processed by OpenVoxDB. This could cause a node targeted for deletion to reappear when the command in the queue gets processed after the deletion operation has run. diff --git a/documentation/api/command/v1/commands.markdown b/documentation/api/command/v1/commands.markdown index 3fffeaa41..a2b3d4a85 100644 --- a/documentation/api/command/v1/commands.markdown +++ b/documentation/api/command/v1/commands.markdown @@ -20,7 +20,7 @@ canonical: "/puppetdb/latest/api/command/v1/commands.html" [expirev1]: ../../wire_format/configure_expiration_format_v1.markdown [inputsv1]: ../../wire_format/catalog_inputs_format_v1.markdown -Commands are used to change PuppetDB's model of a population. Commands are +Commands are used to change OpenVoxDB's model of a population. Commands are specified using these values: `command` is a string identifying the name of the command. @@ -38,7 +38,7 @@ should be applied to. `checksum` (optional) is a SHA-1 hash of the payload which will be used for content verification with the server. This value is not required. -The PuppetDB termini for Puppet Servers use this command API to update facts, +The OpenVoxDB termini for OpenVox Servers use this command API to update facts, catalogs, and reports for nodes, and will always include the checksum. ## Command submission @@ -53,7 +53,7 @@ two mechanisms: This method entails POSTing the command name, version, certname and optionally the checksum as query parameters, with the POST body containing the given command's payload according to its wire format. Providing this information via -query parameters allows PuppetDB to provide better validation and feedback at +query parameters allows OpenVoxDB to provide better validation and feedback at time of POSTing without having to parse the JSON body. This is the preferred method of command submission. @@ -103,8 +103,8 @@ following: server-side logs. > **Note**: a successful response only means that the command has been been -> successfully queued. The command may still fail once PuppetDB tries to -> execute it sometime in the future. Check the PuppetDB logs if you suspect a +> successfully queued. The command may still fail once OpenVoxDB tries to +> execute it sometime in the future. Check the OpenVoxDB logs if you suspect a > command is failing. When a command submission fails, the submitter will receive the following: @@ -121,7 +121,7 @@ When a command submission fails, the submitter will receive the following: >non-blocking command submission. When submitting a command, you may specify the "secondsToWaitForCompletion" -query parameter. If you do, PuppetDB will block the request until the command +query parameter. If you do, OpenVoxDB will block the request until the command has been processed, or until the specified timeout has passed, whichever comes first. The response will contain the following additional keys: @@ -140,11 +140,11 @@ command size by setting the following custom header: `X-Uncompressed-Length: `. This header is used to update command size metrics and compared against `max-command-size` when `reject-large-commands` is set to true. All commands -sent from the PuppetDB termini now include this header by default. +sent from the OpenVoxDB termini now include this header by default. ## Command semantics -Commands are processed _asynchronously_. If PuppetDB returns a 200 +Commands are processed _asynchronously_. If OpenVoxDB returns a 200 when you submit a command, that only indicates that the command has been _accepted_ for processing. There are no guarantees as to when that command will be processed, nor that when it is processed it will @@ -162,7 +162,7 @@ processed. * The nullable `producer` property has been added. -The payload is expected to be a Puppet catalog, as a JSON object, +The payload is expected to be an OpenVox catalog, as a JSON object, conforming exactly to the [catalog wire format v9][catalogv9]. Extra or missing fields are an error. @@ -188,7 +188,7 @@ payload of this command. `type` fields have been added. The payload is expected to be a report, containing events that occurred on -Puppet resources. It is structured as a JSON object, conforming to the +OpenVox resources. It is structured as a JSON object, conforming to the [report wire format v8][reportv8]. ## Deprecated commands @@ -197,7 +197,7 @@ Puppet resources. It is structured as a JSON object, conforming to the * The nullable `catalog_uuid` property has been added. -The payload is expected to be a Puppet catalog, as a JSON object, +The payload is expected to be an OpenVox catalog, as a JSON object, conforming exactly to the [catalog wire format v8][catalogv8]. Extra or missing fields are an error. @@ -205,7 +205,7 @@ or missing fields are an error. * The nullable `code_id` property has been added. -The payload is expected to be a Puppet catalog, as a JSON object, +The payload is expected to be an OpenVox catalog, as a JSON object, conforming exactly to the [catalog wire format v7][catalogv7]. Extra or missing fields are an error. @@ -216,7 +216,7 @@ or missing fields are an error. * The catalog `name` field has been renamed to `certname`. -The payload is expected to be a Puppet catalog, as a JSON object, +The payload is expected to be an OpenVox catalog, as a JSON object, conforming exactly to the [catalog wire format v6][catalogv6]. Extra or missing fields are an error. @@ -236,7 +236,7 @@ payload of this command. properties have been added. The payload is expected to be a report, containing events that occurred on -Puppet resources. It is structured as a JSON object, conforming to the +OpenVox resources. It is structured as a JSON object, conforming to the [report wire format v7][reportv7]. ### "store report", version 6 @@ -245,11 +245,11 @@ The version 6 store report command differs from previous versions by changing from a `resource_events` property to a `resources` property. The `resource_events` property was a merged version of `resources` and their associated events `events`. This new version moves the command to use a similar -format to a raw Puppet report, with a list of `resources`, each with an `events` +format to a raw OpenVox report, with a list of `resources`, each with an `events` property containing a list of the resource's events. The payload is expected to be a report, containing events that occurred on -Puppet resources. It is structured as a JSON object, conforming to the +OpenVox resources. It is structured as a JSON object, conforming to the [report wire format v6][reportv6]. ### "store report", version 5 @@ -260,7 +260,7 @@ puppet run with `--noop`, as well as in the conversion of dash-separated fields underscored. The payload is expected to be a report, containing events that occurred on -Puppet resources. It is structured as a JSON object, conforming to the +OpenVox resources. It is structured as a JSON object, conforming to the [report wire format v5][reportv5]. ### "configure expiration", version 1 (experimental) @@ -270,7 +270,7 @@ The payload should be a JSON format command, conforming to the not facts should be expired for a given `certname`. > *Note*: this is an experimental command, which might be altered or -> removed in a future release, and for the time being, PuppetDB +> removed in a future release, and for the time being, OpenVoxDB > exports will not include this information. ### "replace catalog inputs", version 1 diff --git a/documentation/api/ext/v1/managed-packages.markdown b/documentation/api/ext/v1/managed-packages.markdown deleted file mode 100644 index 2042c34a0..000000000 --- a/documentation/api/ext/v1/managed-packages.markdown +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: "Managed Packages endpoints" -layout: default -canonical: "/puppetdb/latest/api/query/v4/managed-packages.html" ---- - -# Managed Packages endpoints - -[curl]: ../curl.markdown#using-curl-from-localhost-non-sslhttp -[paging]: ./paging.markdown - -> **PE-only**: The Managed Packages endpoints are only available for Puppet -> Enterprise. - -## `managed-packages` - -Returns all installed packages along with the certname of the nodes they are -installed on. For the puppet managed packages provides even resource hash and -manifest file. - -### Query fields - -* `certname` (string): The certname of the node the package data was collected - from. - -* `package_name` (string): The name of the package. (e.g. `emacs24`) - -* `version` (string): The version of the package, in the format used by the - package provider. (e.g. `24.5+1-6ubuntu1`) - -* `provider` (string): The name of the provider which the package data came from; - typically the name of the packaging system. (e.g. `apt`) - -* `resource` (string): a SHA-1 hash of the managed resource's type, title, and parameters, for identification. - -* `file` (string): the manifest file in which the managed resource was declared. - -* `line` (number): the line of the manifest on which the managed resource was declared. - -* `managed_version` (string): The version of the package that Puppet is trying to maintain - -### Response format - -The response is a JSON array of hashes, where each hash has the form: - - {"certname":, - "package_name":, - "version":, - "provider":, - "resource":, - "file":, - "line":, - "managed_version":} - -The array is unsorted by default. - - -### Example - -[You can use `curl`][curl] to query information about managed packages: - - curl -G http://localhost:8080/pdb/query/v4 --data-urlencode 'query=["from", "managed-packages", ["~", "package_name", "ssl"]]' - - -## `extended-managed-packages` - -Returns the same data as managed-packages but adds environment, os and os_release fields. - -### Query fields - -Same as managed-packages plus the following - -* `environment` (string): The environment of the node - -* `os` (string): The operating system of the node - -* `os_release` (string): The operating system release of the node - -### Response format - -The response is a JSON array of hashes, where each hash has the form: - - {"certname":, - "package_name":, - "version":, - "provider":, - "resource":, - "file":, - "line":, - "managed_version":, - "environment":, - "os":, - "os_release":} - -The array is unsorted by default. - - -### Example - -[You can use `curl`][curl] to query information about managed packages: - - curl -G http://localhost:8080/pdb/query/v4 --data-urlencode 'query=["from", "extended-managed-packages", ["~", "package_name", "ssl"]]' - - -## Paging - -This query endpoint supports paged results via the common PuppetDB paging -URL parameters. For more information, please see the documentation -on [paging][paging]. diff --git a/documentation/api/ext/v1/resource-graphs.markdown b/documentation/api/ext/v1/resource-graphs.markdown deleted file mode 100644 index 29459ce58..000000000 --- a/documentation/api/ext/v1/resource-graphs.markdown +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: "Extensions API (PE only)" -layout: default -canonical: "/puppetdb/latest/api/ext/v1/resource-graphs.html" ---- - -# Extensions API (PE only) - -[paging]: ../../query/v4/paging.markdown -[query]: ../../query/v4/query.markdown -[subqueries]: ../../query/v4/ast.markdown#subquery-operators -[ast]: ../../query/v4/ast.markdown -[environments]: ../../query/v4/environments.markdown -[nodes]: ../../query/v4/nodes.markdown -[statuses]: https://puppet.com/docs/puppet/latest/format_report.html#puppettransactionreport - -You can query resource-graphs by making an HTTP request to the -`/pdb/ext/v1/resource-graphs` endpoint. - -## `/pdb/ext/v1/resource-graphs` - -This will return a JSON array containing all the resource-graphs for each node -in your infrastructure. - -This resource-graph is a unified view of data from the report and the catalog so -that all resource information from a puppet run (parameters from catalogs, -events from reports, etc.) is present in one place. - -### URL Parameters - -* `query`: Optional. A JSON array containing the query in prefix notation - (`["", "", ""]`). See the sections below for the - supported operators and fields. For general info about queries, see - [the page on query structure.][query] - -If a query parameter is not provided, all results will be returned. - -### Query Operators - -See [the AST query language page][ast]. - -### Query Fields - -* `certname` (string): the certname associated with the resource-graph -* `environment` (string): the environment assigned to the node that submitted - the report. -* `transaction_uuid` (string): string used to identify a puppet run. -* `catalog_uuid` (string): a string used to tie a catalog to its associated - reports -* `code_id` (string): a string used to tie a catalog to the Puppet code which - generated the catalog -* `producer_timestamp` (timestamp): is the time of catalog submission from the - Puppet Server to PuppetDB, according to the clock on the Puppet Server. Timestamps are - always [ISO-8601][8601] compatible date/time strings. -* `status` (string): the status associated to report's node. Possible values for - this field come from Puppet's report status, which can be found - [here][statuses]. -* `noop` (boolean): a flag indicating whether the report was produced by a noop - run. - -### Subquery Relationships - -Here is a list of related entities that can be used to constrain the result set -using implicit subqueries. For more information consult the documentation for -[subqueries][subqueries]. - -* [`nodes`][nodes]: Node for a catalog. -* [`environments`][environments]: Environment for a catalog. - -### Response Format - -Successful responses will be in `application/json`. - -The result will be a JSON array with one entry per certname. Each entry is of -the form: - - { - "certname" : , - "environment" : , - "catalog_uuid" : , - "transaction_uuid" : , - "code_id" : , - "producer_timestamp":