Meta tags:
description=
Warning
Chef Backend is deprecated and no longer under active development. Contact your Chef account representative for information about migrating to Chef Automate HA.;
Headings (most frequently used words):
syntax, examples, options, cluster, config, backend, status, gen, node, set, failover, service, example, output, chef, ctl, backup, create, cleanse, demote, force, leader, gather, logs, sample, server, help, join, promote, reconfigure, remove, restore, show, uninstall, subcommands, configure, the, front, end, hup, int, kill, once, restart, list, start, stop, tail, term,
Text of the page (most frequently used words):
the (366), chef (259), #backend (155), cluster (104), subcommand (94), this (90), and (81), node (73), syntax (72), #service (67), server (67), ctl (64), postgresql (62), command (56), for (54), infra (54), overview (46), has (45), following (45), run (39), use (37), that (37), options (35), all (34), not (34), leader (33), install (33), config (32), with (32), automate (31), status (30), examples (30), builder (30), services (29), nodes (29), elasticsearch (29), deployment (29), version (29), configure (26), backup (26), will (26), list (25), leaderl (24), aws (24), service_name (23), are (22), data (22), machine (21), about (21), any (20), from (20), file (20), habitat (20), restore (19), name (19), running (19), etcd (19), set (18), configuration (18), supermarket (18), upgrade (18), start (17), output (17), state (17), log (17), settings (17), manage (17), recovery (16), api (16), packages (16), prem (16), failover (15), create (15), where (14), should (14), pid (14), users (14), reference (14), gen (13), logs (13), community (13), database (13), specified (13), stop (12), restart (12), example (12), time (12), var (12), ssl (12), management (12), workstation (12), license (12), 360 (12), managed (12), uninstall (11), remove (11), reconfigure (11), individual (11), return (11), when (11), started (11), available (11), external (11), path (11), address (11), can (10), after (10), specifying (10), which (10), true (10), non (10), code (10), option (10), frontend (10), compliance (10), client (10), platform (10), effortless (10), saas (10), opensearch (10), used (9), represents (9), listed (9), also (9), enable (9), exit (9), vip (9), interface (9), fqdn (9), log_rotation (9), files (9), system (9), tail (8), once (8), kill (8), force (8), send (8), may (8), first (8), opt (8), zero (8), already (8), secrets (8), json (8), package (8), cloud (8), resources (8), prerequisites (8), origin (8), disaster (8), requirements (8), desktop (8), guide (8), certificates (8), iam (8), page (7), term (7), int (7), hup (7), join (7), was (7), process (7), supervisor (7), each (7), enabled (7), troubleshooting (7), disabled (7), local (7), false (7), prompt (7), none (7), new (7), certificate (7), etcd_pool (7), get (7), using (7), show (6), promote (6), help (6), sample (6), gather (6), demote (6), feedback (6), down (6), similar (6), been (6), but (6), healthy (6), directory (6), existing (6), error (6), message (6), etc (6), cookbooks (6), audit (6), migrate (6), inspec (6), style (6), security (6), cookstyle (6), supported (6), update (6), integrations (6), dashboard (6), applications (6), add (6), enterprise (6), one (5), does (5), policy (5), terms (5), licensing (5), front (5), cleanse (5), yes (5), successfully (5), wait (5), then (5), high (5), availability (5), warning (5), commands (5), note (5), application (5), shows (5), follower (5), generated (5), installation (5), must (5), exist (5), named (5), default (5), publish (5), bootstrap (5), exists (5), user (5), core (5), elected (5), progress (4), trademarks (4), their (4), subcommands (4), your (4), configured (4), seconds (4), have (4), useful (4), 59m (4), confirmation (4), empty (4), created (4), removed (4), complete (4), bootstrapping (4), against (4), only (4), values (4), information (4), rabbitmq (4), opscode_erchef (4), num_to_keep (4), file_maxbytes (4), 104857600 (4), log_directory (4), active (4), downloads (4), organizations (4), groups (4), roles (4), saml (4), ldap (4), resource (4), packs (4), profiles (4), download (4), apis (4), upgrades (4), monitor (4), private (4), quick (4), deprecations (4), cops (4), firewalls (4), ports (4), authentication (4), authorization (4), origins (4), profile (4), minio (4), single (4), cookbook (4), enrollment (4), setup (4), infrastructure (4), getting (4), migration (4), courier (4), tokens (4), jobs (4), app (4), integration (4), amazon (4), a2ha (4), premises (4), platforms (4), edition (4), product (3), names (3), software (3), its (3), other (3), modified (3), end (3), table (3), contents (3), document (3), support (3), github (3), normally (3), timeout (3), unless (3), they (3), prevent (3), because (3), simple (3), 106983s (3), health (3), part (3), view (3), prior (3), off (3), during (3), setting (3), within (3), value (3), rejoin (3), provided (3), choose (3), network (3), event (3), peer_node_ip (3), generate (3), automatically (3), vip_interface (3), publish_address (3), specify (3), opscode_solr4 (3), actions (3), chef_pgsql (3), connect (3), group (3), data_dir (3), verify (3), rebuild (3), store (3), account (3), content (3), herein (2), registered (2), corporation (2), subsidiaries (2), affiliates (2), see (2), appropriate (2), rights (2), reserved (2), respective (2), owners (2), 2026 (2), you (2), improve (2), contact (2), still (2), built (2), required (2), two (2), processes (2), stopped (2), respond (2), means (2), 12345 (2), identify (2), fails (2), removing (2), shut (2), including (2), more (2), 6640 (2), 106984s (2), 6788 (2), 6742 (2), 6661 (2), followers (2), synced (2), online (2), three (2), distributed (2), green (2), disable (2), archive (2), tar (2), via (2), otherwise (2), replaced (2), either (2), could (2), allowed (2), quorum (2), joins (2), accessible (2), currently (2), ip_address (2), becomes (2), peer (2), joined (2), overwrite (2), necessary (2), 192 (2), 9200 (2), db_superuser (2), results (2), vary (2), depending (2), opscode (2), ciphers (2), nil (2), port (2), hot_standby (2), specific (2), under (2), contains (2), located (2), partitions (2), form (2), identifier (2), maximum (2), amount (2), line (2), longer (2), environments (2), bags (2), clients (2), console (2), legacy (2), azure (2), remediation (2), release (2), notes (2), share (2), what (2), scaffolding (2), variables (2), pattern (2), attributehelper (2), attributedefault (2), useplatformhelpers (2), unnecessaryplatformcasestatement (2), unnecessaryoscheck (2), trueclassfalseclassresourceproperties (2), simplifyplatformmajorversioncheck (2), overlycomplexsupportsdependsmetadata (2), negatingonlyif (2), includerecipewithparentheses (2), immediatenotificationtiming (2), filemode (2), defaultcopyrightcomments (2), copyrightcommentformat (2), commentsentencespacing (2), commentformat (2), chefwhaaat (2), attributekeys (2), invalidlicensestring (2), insecurecookbookurl (2), includeresourceexamples (2), includeresourcedescriptions (2), includepropertydescriptions (2), emptymetadatafield (2), defaultmetadatamaintainer (2), sharing (2), sshprivatekey (2), unlessdefinedrequire (2), requirenethttps (2), legacypowershelloutmethods (2), gemspecrequirerubygems (2), gemspeclicense (2), ruby (2), usecreateifmissing (2), unnecessarynameproperty (2), unnecessarydesiredstate (2), suggestsmetadata (2), stringpropertywithnildefault (2), sensitivepropertyinresource (2), resourcewithnothingaction (2), replacesmetadata (2), recipemetadata (2), providesmetadata (2), propertywithrequiredanddefault (2), propertysplatregex (2), ohaiattributetostring (2), namepropertyisrequired (2), multipleplatformchecks (2), longdescriptionmetadata (2), groupingmetadata (2), doublecompiletime (2), customresourcewithallowedactions (2), conflictsmetadata (2), attributemetadata (2), aptrepositorynotifiesaptupdate (2), aptrepositorydistributiondefault (2), redundantcode (2), zipfileresource (2), windowszipfileusage (2), windowsscresource (2), windowsregistryuac (2), whyrunsupportedtrue (2), useszypperrepo (2), userequirerelative (2), usemultipackageinstalls (2), usecheflanguagesystemdhelper (2), usecheflanguageenvhelpers (2), usecheflanguagecloudhelpers (2), usebuildessentialresource (2), unnecessarymixlibshelloutrequire (2), unnecessarydependschef15 (2), unnecessarydependschef14 (2), sysctlparamresource (2), simplifyaptppasetup (2), shellouttochocolatey (2), shellouthelper (2), sevenziparchiveresource (2), setorreturninresources (2), respondtoresourcename (2), respondtoprovides (2), respondtoinmetadata (2), respondtocompiletime (2), resourcenamefrominitialize (2), resourceforcingcompiletime (2), providesfrominitialize (2), propertywithnameattribute (2), powershellscriptexpandarchive (2), powershellinstallwindowsfeature (2), powershellinstallpackage (2), powershellguardinterpreter (2), osxconfigprofileresource (2), opensslx509resource (2), opensslrsakeyresource (2), noderolesinclude (2), nodeinitpackage (2), minitesthandlerusage (2), macosxuserdefaults (2), libarchivefileresource (2), legacyberksfilesource (2), includingwindowsdefaultrecipe (2), includingohaidefaultrecipe (2), includingmixinshelloutinresources (2), includingaptdefaultrecipe (2), ifprovidesdefaultaction (2), foodcriticcomments (2), executetzutil (2), executesysctl (2), executesleep (2), executescexe (2), executeaptupdate (2), emptyresourceinitializemethod (2), dslincludeinresource (2), dependsonzyppercookbook (2), dependsonwindowsfirewallcookbook (2), dependsontimezonelwrpcookbook (2), dependsonopensslcookbook (2), dependsonlocalecookbook (2), dependsonkernelmodulecookbook (2), dependsonchocolateycookbooks (2), dependsonchefvaultcookbook (2), definitions (2), defineschefspecmatchers (2), defaultactionfrominitialize (2), declareactionclass (2), databaghelpers (2), customresourcewithattributes (2), cronmanageresource (2), crondfileortemplate (2), conditionalusingtest (2), classevalactionclass (2), chefgemnokogiri (2), allowedactionsfrominitialize (2), actionmethodinresource (2), modernize (2), searchforenvironmentsorroles (2), dependschefvault (2), cookbookusessearch (2), cookbookusesroles (2), cookbookusespolicygroups (2), cookbookusesenvironments (2), cookbookusesdatabags (2), chefvaultused (2), berksfile (2), windowsversionhelpers (2), windowstaskchangeaction (2), windowspackageinstallertypestring (2), windowsfeatureservermanagercmd (2), verifypropertyusesfileexpansion (2), useyamldump (2), usesruncommandhelper (2), usesdeprecatedmixins (2), useschefresthelpers (2), userdeprecatedsupportsproperty (2), useinlineresourcesdefined (2), useautomaticresourcename (2), searchusespositionalparameters (2), rubyblockcreateaction (2), ruby27keywordargumentwarnings (2), resourcewithoutunifiedtrue (2), resourceusesupdatedmethod (2), resourceusesproviderbasemethod (2), resourceusesonlyresourcename (2), resourceusesdslnamemethod (2), resourceoverridesprovidesmethod (2), resourceinheritsfromcompatresource (2), requirerecipe (2), powershellcookbookhelpers (2), policyfilecommunitysource (2), poisearchiveusage (2), partialsearchhelperusage (2), partialsearchclassusage (2), nodesetwithoutlevel (2), nodesetunless (2), nodeset (2), nodemethodsinsteadofattributes (2), nodedeepfetch (2), namepropertywithdefaultvalue (2), macosuserdefaultsglobalproperty (2), logresourcenotifications (2), localedeprecatedlcallproperty (2), librarianchefspec (2), legacyyumcookbookrecipes (2), legacynotifysyntax (2), launchddeprecatedhashproperty (2), includingyumdnfcompatrecipe (2), includingxmlrubyrecipe (2), hwrpwithoutunifiedtrue (2), hwrpwithoutprovides (2), foodcritictesting (2), foodcriticfile (2), executerelativecreateswithoutcwd (2), executepathproperty (2), erlcallresource (2), epicfail (2), eolauditmodeusage (2), easyinstallresource (2), deprecatedyumrepositoryproperties (2), deprecatedyumrepositoryactions (2), deprecatedwindowsversioncheck (2), deprecatedsudoactions (2), deprecatedshelloutmethods (2), deprecatedplatformmethods (2), deprecatedchefspecplatform (2), dependsonomnibusupdatercookbook (2), dependsonchefreportingcookbook (2), dependsonchefnginxcookbook (2), delivery (2), cookbooksdependsonself (2), cookbookdependsonpoise (2), cookbookdependsonpartialsearch (2), cookbookdependsoncompatresource (2), chocolateypackageuninstallaction (2), chefwindowsplatformhelper (2), chefsugarhelpers (2), chefspeclegacyrunner (2), chefspeccoveragereport (2), chefshellout (2), chefrewind (2), chefhandlerusessupports (2), chefhandlerrecipe (2), cheffile (2), chefdkgenerators (2), tmppath (2), supportsmustbefloat (2), serviceresource (2), scopedfileexist (2), resourcewithnoneaction (2), resourcesetsnameproperty (2), resourcesetsinternalproperties (2), propertywithouttype (2), powershellscriptdeletefile (2), powershellfileexists (2), opensslpasswordhelpers (2), octalmodeasstring (2), notifiesactionnotsymbol (2), nodenormalunless (2), nodenormal (2), metadatamissingversion (2), metadatamissingname (2), metadatamalformeddepends (2), malformedplatformvalueforplatformhelper (2), macosuserdefaultsinvalidtype (2), lazyinresourceguard (2), lazyevalnodeattributedefaults (2), invalidversionmetadata (2), invalidplatformvalueforplatformhelper (2), invalidplatformvalueforplatformfamilyhelper (2), invalidplatformmetadata (2), invalidplatformincase (2), invalidplatformhelper (2), invalidplatformfamilyincase (2), invalidplatformfamilyhelper (2), invalidnotificationtiming (2), invalidnotificationresource (2), invaliddefaultaction (2), invalidcookbookname (2), incorrectlibraryinjection (2), emptyresourceguard (2), dnfpackageallowdowngrades (2), cookbookusesnodesave (2), conditionalrubyshellout (2), chefapplicationfatal (2), blockguardwithonlystring (2), correctness (2), v25 (2), v26 (2), tuning (2), failure (2), optional (2), usage (2), tiered (2), airgap (2), capacity (2), planning (2), plan (2), base (2), 2025 (2), refresh (2), strategy (2), membership (2), rbac (2), keys (2), rotate (2), certs (2), separate (2), scale (2), artifactory (2), artifact (2), warm (2), spare (2), env (2), windows_update_settings (2), windows_power_management (2), windows_password_policy (2), windows_ie_esc (2), windows_firewall (2), windows_disk_encryption (2), windows_desktop_winrm_settings (2), windows_desktop_screensaver (2), windows_defender_exclusion (2), windows_defender (2), windows_choco_installer (2), windows_automatic_logout (2), windows_app_management (2), windows_admin_control (2), rescue_account (2), macos_power_management (2), macos_password_policy (2), macos_firewall (2), macos_disk_encryption (2), macos_desktop_screensaver (2), macos_automatic_software_updates (2), macos_automatic_logout (2), macos_app_management (2), macos_admin_control (2), windows (2), macos (2), touch (2), redirect (2), sso (2), opsworks (2), skills (2), administration (2), guides (2), enroll (2), clis (2), san (2), best (2), practices (2), feature (2), flags (2), cli (2), architecture (2), administrator (2), incident (2), servicenow (2), marketplace (2), runs (2), scan (2), reports (2), eas (2), feed (2), teams (2), policies (2), projects (2), credentials (2), lifecycle (2), feeds (2), notifications (2), cleanup (2), monitoring (2), centralize (2), large (2), report (2), ingestion (2), invalid (2), login (2), attempts (2), telemetry (2), session (2), disclosure (2), panel (2), banner (2), collection (2), topics (2), manager (2), bastion (2), sudo (2), password (2), rds (2), vpc (2), cidr (2), load (2), balancer (2), faqs (2), performance (2), benchmarks (2), rotation (2), self (2), signed (2), custom (2), generation (2), place (2), efs (2), back (2), object (2), storage (2), filesystem (2), customer (2), airgapped (2), tutorial (2), shortcodes (2), matter (2), reuse (2), hugo (2), procedures (2), tables (2), headings (2), notices (2), markdown (2), lists (2), linking (2), formatting (2), tools (2), house (2), contribute (2), docs (2), guidelines (2), contributions (2), commercial (2), script (2), versions (2), key (2), accept (2), training (2), blog (2), main (2), certain, countries, markings, contained, inclusion, imply, endorsement, affiliation, sponsorship, between, copyright, last, february, cookie, privacy, trademark, site, map, thank, submit, fill, field, how, ask, stuck, edit, helpful, ensures, given, starts, provides, managing, sigterm, follow, 388s, 393s, something, diwb, seven, references, signal, sent, yet, actually, comply, general, timed, out, big, concern, failing, signals, responding, like, investigate, cause, display, labeled, asterisk, restarted, restarting, trigger, errors, starting, followed, look, trouble, asked, change, tell, attempt, sigkill, sigint, sighup, revert, without, runit, identifiers, uptime, degraded, 6653, 106976s, 6739, 106982s, 106981s, 6630, 6667, selected, both, columns, summarize, column, 43s, offline, syncing, 35s, waiting, total, 39s, 41s, full, returned, most, early, stages, ensure, everything, properly, across, backup_file, tgz, operation, enough, space, expand, staging, dir, executed, delete, replace, node_name, itself, physically, deleting, going, unsuccessful, promoted, absolute, location, begin, defined, published, addresses, bound, bind, interfaces, successful, added, found, valid, declines, member, query, items, print, machines, s3_url_expiry_window_size, nginx_bookshelf_caching, dark_launch, opscode_expander, queue_length_monitor_enabled, management_enabled, bookshelf, sql, storage_type, batch, search_queue_mode, search_provider, http, external_url, 6810e52a01e562, db_superuser_password, frontend1, demo, com, these, carefully, root, permission, copy, higher, contain, bootstrapped, separately, organizational_unit_name, operations, key_length, 2048, duration, 3650, country_name, company_name, youcorp, shown, certificate_key, max_count, max_connection_duration_seconds, 300, max_age_seconds, init_count, ibrowse_options, inactivity_timeout, infinity, http_timeout_ms, 5000, cull_interval_seconds, max_messages_per_second, 1000, status_post_update_interval_seconds, status_internal_update_interval_seconds, leader_ttl_seconds, health_check_interval_seconds, db_timeout, 2000, control_worker_timeout_seconds, temp_directory, scripts_directory, scripts, plugins_directory, plugins, new_size, jvm_opts, heap_size, 248, work_mem, 8mb, wal_log_hints, wal_level, wal_keep_segments, username, shmmax, 17179869184, shmall, 4194304, shared_buffers, 248mb, replication_user, replicator, 5432, min_wal_size, md5_auth_cidr_addresses, samehost, samenet, max_wal_size, max_wal_senders, max_replication_slots, max_connections, 350, log_min_duration_statement, keepalives_interval, keepalives_idle, keepalives_count, effective_cache_size, 496mb, checkpoint_warning, 30s, checkpoint_timeout, 5min, checkpoint_completion_target, archive_timeout, archive_mode, archive_command, peer_port, 2380, client_port, 2379, eth0, ip_version, ipv4, hide_sensitive, be1, tuned, guidance, identical, directed, along, into, tarball, important, visible, check, discovering, scenario, expected, number, before, waiting_for_leader, determine, believed, unhealthy, them, appears, become, there, election, prevented, original, demoted, current, role, destroy, put, disk, remain, recreate, able, cannot, reset, rebuilt, resets, loss, initialize, assist, entire, typically, includes, utility, tool, maintained, development, representative, migrating, deprecated, menu, search, skip,
Text of the page (random words):
300 leaderl etcd_pool max_count 10 ssl certificate nil ssl certificate_key nil ssl ciphers a list of ciphers not shown ssl company_name youcorp ssl country_name us ssl data_dir var opt chef backend ssl ssl duration 3650 ssl key_length 2048 ssl organizational_unit_name operations gen server config use the gen server config subcommand to generate output for the etc opscode chef server rb configuration file this command may be run from any machine in the backend ha cluster but must be run separately for each node that is part of the frontend group this command will complete with an exit code of 0 if the chef server rb file is created successfully return an error message and a non zero exit code if a node has not been bootstrapped or joined or if a fqdn is not provided syntax this subcommand has the following syntax chef backend ctl gen server config fqdn configure the front end on any node in the backend ha cluster run the following command for each node in the frontend group chef backend ctl gen server config fqdn f chef server rb fqdn where fqdn is the fqdn for the frontend machine the generated chef server rb file will contain all of the values necessary for any frontend chef infra server to connect to and bootstrap against the backend ha cluster on each frontend machine install the chef server core package version 12 4 0 or higher on each frontend machine copy the generated chef server rb fqdn to etc opscode chef server rb on each frontend machine with root permission run the following command chef server ctl reconfigure example output the following example shows the results of running the chef backend ctl gen server config subcommand the settings and output will vary depending on the configuration these settings should be modified carefully fqdn frontend1 chef demo com postgresql external true postgresql vip 192 0 2 0 postgresql db_superuser chef_pgsql postgresql db_superuser_password 6810e52a01e562 opscode_solr4 external true opscode_solr4 external_url http 192 0 2 0 9200 opscode_erchef search_provider elasticsearch opscode_erchef search_queue_mode batch bookshelf storage_type sql rabbitmq enable false rabbitmq management_enabled false rabbitmq queue_length_monitor_enabled false opscode_expander enable false dark_launch actions false opscode_erchef nginx_bookshelf_caching on opscode_erchef s3_url_expiry_window_size 50 note the opscode_solr4 postgresql and rabbitmq services are disabled in this configuration file for the frontend machines when running the chef infra server with a backend ha cluster help use the help subcommand to print a list of all available chef backend ctl commands this subcommand has the following syntax chef backend ctl help join cluster use the join cluster subcommand to configure a node to be a member of the backend ha cluster as a peer of the node at the specified peer_node_ip ip address this command will query the existing cluster to identify any necessary configuration information if the publish address and vip interface options are not specified and are specified in chef backend rb the command will prompt with a list of items from which to choose this command will return an error message and a non zero exit code when the secrets file path option is specified a non empty secrets file already exists at etc chef backend secrets json and the user declines to overwrite it the secrets file path option is specified but does not specify a valid file and or the file at etc chef backend secrets json is empty or does not exist the ip address specified by the publish address option does not exist on the node the interface specified by the vip interface option does not exist on the node any ip address on the node is already registered in the backend ha cluster the node is already configured for the backend ha cluster and the recovery option is not specified the recovery option is specified but no existing installation is found publish address and or vip interface are specified but a non empty chef backend rb file already exists this command will not overwrite a chef backend rb file if successful this command will generate a chef backend rb file at etc chef backend chef backend rb with the values for the publish_address vip_interface and vip added automatically syntax this subcommand has the following syntax chef backend ctl join cluster peer_node_ip options where peer_node_ip is the ip address of a peer in the cluster to be joined options this subcommand has the following options i interface vip interface interface the network interface to which the backend vip will bind in the event that this node becomes leader if not provided and if not specified in chef backend rb this command will prompt to choose from a list of interfaces that are currently available on the node note this option should only be used the first time a node joins the backend ha cluster p ip_address publish address ip_address the ip address that is published within the backend ha cluster this ip address must be accessible to all nodes in the backend ha cluster if not provided and if not specified in chef backend rb this command will prompt to choose from a list of ip addresses that are currently bound on the node note this option should only be used the first time a node joins the backend ha cluster recovery force this node to rejoin the backend ha cluster if it has been removed via the chef backend ctl remove node or chef backend ctl bootstrap with quorum recovery commands note this option will run against the existing chef backend rb file which means the vip interface and publish address options should not be specified they are already defined in the chef backend rb file s path secrets file path path the absolute path to the location of the secrets json file on the bootstrapping node the path should begin with a default value etc chef backend secrets json y yes do not prompt for confirmation examples none promote use the promote subcommand to promote the named node to be leader of the backend ha cluster this command will complete with an exit code of 0 when the leader of the backend ha cluster is replaced as leader by the named node return an error message and a non zero exit code if the named node is already leader because failover has been disabled for either the cluster or the node or if the new leader could not be promoted within the allowed time syntax this subcommand has the following syntax chef backend ctl promote node examples none reconfigure use the reconfigure subcommand to reconfigure a machine in the chef infra server backend ha cluster this subcommand will also restart any services for which the service_name enabled setting is set to true this subcommand has the following syntax chef backend ctl reconfigure remove node use the remove node subcommand to remove the named node from the backend ha cluster by removing the node s status from etcd and deleting it from the etcd cluster this command is useful when a node is going to be replaced or if the join cluster command was unsuccessful this command may not be run from the node that is to be removed the node itself must be shut down physically or have all services stopped via the the chef backend ctl stop command if the node is still running or otherwise available to the backend ha cluster this command will return an error message and a non zero exist code syntax this subcommand has the following syntax chef backend ctl remove node node_name options this subcommand has the following options y yes do not prompt for confirmation examples none restore use the restore subcommand to restore a backup created by the chef backend ctl backup subcommand this command should be executed on the leader node in the backend ha cluster this command will delete all existing data and replace it with the data in the backup archive syntax this subcommand has the following syntax chef backend ctl restore path options where path is the path to a tar gz file that was created by the chef backend ctl backup subcommand options this subcommand has the following options d directory staging dir directory the path to an empty directory to be used during the restore operation this directory must have enough available space to expand all data in the backup archive y yes do not prompt for confirmation examples restore data to the backend leader from the leader node run the following command chef backend ctl restore var opt chef backup backup_file tgz set cluster failover use the set cluster failover subcommand to enable or disable failover across the backend ha cluster syntax this subcommand has the following syntax chef backend ctl set cluster failover state where state may be one of on off true false enabled or disabled set node failover use the set node failover subcommand to enable or disable failover for a node in the backend ha cluster syntax this subcommand has the following syntax chef backend ctl set node failover state where state may be one of on off true false enabled or disabled show config the show config subcommand is used to view the configuration that will be generated by the reconfigure subcommand this command is most useful in the early stages of a deployment to ensure that everything is built properly prior to installation this subcommand has the following syntax chef backend ctl show config status use the status subcommand to show the status of all services available to a node in the backend ha cluster this subcommand has the following syntax chef backend ctl status and will return the status for all services status can be returned for individual services by specifying the name of the service as part of the command chef backend ctl status service_name for example full output chef backend ctl status is similar to service local status time in state distributed node status elasticsearch running pid 6661 1d 5h 59m 41s state green nodes online 3 3 etcd running pid 6742 1d 5h 59m 39s health green healthy nodes 3 3 leaderl running pid 6788 1d 5h 59m 35s leader 1 waiting 0 follower 2 total 3 postgresql running pid 6640 1d 5h 59m 43s leader 1 offline 0 syncing 0 synced 2 which shows status for a healthy backend ha cluster the first three columns service local status and time in state summarize the local state the distributed node status column shows a three node cluster all nodes healthy and online a leader selected with two followers for both leader follower status for the leaderl service and a leader synced state for the postgresql service simple output chef backend ctl status simple is similar to run elasticsearch pid 6661 106983s run log pid 6667 106983s run etcd pid 6742 106981s run log pid 6630 106984s run leaderl pid 6788 106976s run log pid 6739 106982s run postgresql pid 6640 106984s run log pid 6653 106983s which shows the state of the services process identifiers and uptime in seconds simple output is useful if one or more nodes in the backend ha cluster are down or in a degraded state uninstall the uninstall subcommand is used to remove the chef infra server application from a machine in the backend ha cluster but without removing any of the data this subcommand will shut down all services including the runit process supervisor this subcommand has the following syntax chef backend ctl uninstall note to revert the uninstall subcommand run the reconfigure subcommand because the start subcommand is disabled by the uninstall command service subcommands this command has a built in process supervisor that ensures all of the required services are in the appropriate state at any given time the supervisor starts two processes for each service and provides the following subcommands for managing services hup int kill once restart service list start status stop tail and term warning the following commands are disabled when an external postgresql database is configured for the chef infra server hup int kill once restart service list start stop tail and term hup use the hup subcommand to send a sighup to all services on a machine in the chef infra server backend ha cluster this command can also be run for an individual service by specifying the name of the service in the command this subcommand has the following syntax chef backend ctl hup service_name where service_name represents the name of any service that is listed after running the service list subcommand int use the int subcommand to send a sigint to all services on a machine in the chef infra server backend ha cluster this command can also be run for an individual service by specifying the name of the service in the command this subcommand has the following syntax chef backend ctl int service_name where service_name represents the name of any service that is listed after running the service list subcommand kill use the kill subcommand to send a sigkill to all services on a machine in the chef infra server backend ha cluster this command can also be run for an individual service by specifying the name of the service in the command this subcommand has the following syntax chef backend ctl kill service_name where service_name represents the name of any service that is listed after running the service list subcommand once the supervisor for a machine in the chef infra server backend ha cluster is configured to restart any service that fails unless that service has been asked to change its state the once subcommand is used to tell the supervisor to not attempt to restart any service that fails this command is useful when troubleshooting configuration errors that prevent a service from starting run the once subcommand followed by the status subcommand to look for services in a down state and or to identify which services are in trouble this command can also be run for an individual service by specifying the name of the service in the command this subcommand has the following syntax chef backend ctl once service_name where service_name represents the name of any service that is listed after running the service list subcommand restart use the restart subcommand to restart all services enabled on a machine in the chef infra server backend ha cluster or to restart an individual service by specifying the name of that service in the command warning when running the chef infra server in a high availability configuration restarting all services may trigger failover this subcommand has the following syntax chef backend ctl restart service_name where service_name represents the name of any service that is listed after running the service list subcommand when a service is successfully restarted the output should be similar to ok run service_name pid 12345 1s service list use the service list subcommand to display a list of all available services on a machine in the chef infra server backend ha cluster a service that is enabled is labeled with an asterisk this subcommand has the following syntax chef backend ctl service list start use the start subcommand to start all services that are enabled on a machine in the chef infra server backend ha clust...
|
