Skip to main content

Node management settings

When you first deploy Chef 360 Platform or you create a new organization with the default skill assembly and default node management settings, Chef 360 Platform adds the default node cohort to your organization with those default settings.

Cohort

The default node cohort is called sample-node-cohort. All nodes enrolled in this cohort get the default Node Management agent settings, skill assembly, and skill override settings that are described on this page.

To get a list of cohorts in an organization, use the following command:

chef-node-management-cli management cohort find-all-cohorts --profile <NODE_MANAGER_PROFILE_NAME>

For more information, see the node cohort management documentation.

Node Management agent

The Node Management agent is a special skill that manages the node and installs and manages the skills defined in the skill assembly.

The Node Management agent has the following default settings:

  • It fetches skills from the Chef Habitat Builder deployment that Chef 360 Platform is configured to fetch from. This is either https://<CHEF_360_FQDN>:31000/hab/builder/v1 or https://bldr.habitat.sh.
  • It fetches skills from the stable release channel.
  • It checks in with Chef 360 Platform every hour.
  • It updates skill definition metadata every hour.
  • Its log level is warning.

For more information, see the Node Management agent documentation

Optional: Modify Node Management agent settings

You can modify the Node Management agent settings. For example, you can configure it to fetch skills from your own deployment of Habitat Builder.

  • Optional: Modify Node Management agent settings

    If you want to modify the Node Management agent settings, follow these steps:

    1. Create a JSON file with the following settings:

      {
  "settings": [
    {
      "name": "authToken",
      "value": ""
    },
    {
      "name": "bldrUrl",
      "value": "<HABITAT_BUILDER_URL>"
    },
    {
      "name": "bldrChannel",
      "value": "<CHANNEL>"
    },
    {
      "name": "logLevel",
      "value": "<LOG_LEVEL>"
    },
    {
      "name": "nodeCheckinInterval",
      "value": "<CHECK_IN_INTERVAL>"
    },
    {
      "name": "updateSkillMetadataInterval",
      "value": "<UPDATE_SKILL_INTERVAL>"
    },
    {
      "name": "isLogRetention",
      "value": "<IS_LOG_RETENTION>"
    },
    {
      "name": "retentionDays",
      "value": "<RETENTION_DAYS>"
    },
    {
      "name": "maxSize",
      "value": "<MAX_SIZE>"
    }
  ],
  "skillName": "node-management-agent"
}

      Replace:

      • <HABITAT_BUILDER_URL> with one of the following:

        • If you deployed Chef Habitat Builder with your Chef 360 Platform deployment, use https://<CHEF_360_FQDN>:31000/hab/builder/v1.
        • For Chef’s public Habitat Builder, use https://bldr.habitat.sh.
        • If you’re using a separate Habitat Builder deployment, enter the URL of that deployment.

      • <CHANNEL> with the release channel from which to install skills. For example, stable.

      • <CHECK_IN_INTERVAL> with the interval (in seconds) at which check-in occurs. Values start at 3600 (1 hour).

        The check-in interval splay is automatically set to a value between zero and half the check-in interval time.

      • <UPDATE_SKILL_INTERVAL> with the interval (in seconds) at which skill definitions are updated. Values start at 3600 (1 hour).

        The update skill interval splay is automatically set to a value between zero and half the check-in interval time.

      • <LOG_LEVEL>: The logging level of the agent. For example, debug.

        Supported log levels:

        debug
        Reports detailed information that can aid in identifying issues or debugging a workload. This includes the info, warn, and error logs.
        info
        Reports general information about the system’s operations.
        warn
        Reports potential failures, but the operation can continue functioning for the time being.
        error
        Reports errors that prevent the execution of an operation.

      • <IS_LOG_RETENTION>: Whether to enable log retention or not. Allowed values: true, false. Default value is true.

      • <RETENTION_DAYS>: The number of integer days to retain the log file. It must be greater than or equal to 1. Default value is 7.

      • <MAX_SIZE>: The maximum size of the log file. It must be greater than or equal to 1 MB. For example, 1MB. Default value is 100MB.

    2. Get the override settings ID with the find-all-settings command:

      chef-node-management-cli management setting find-all-settings --profile <PROFILE_NAME>

    3. Update the Node Management agent settings with the update-skillSettings command:

      chef-node-management-cli management setting update-skillSettings \
  --skillName node-management-agent \
  --body-file <PATH_TO_JSON_FILE> \
  --settingId <SETTINGS_ID> \
  --profile <PROFILE_NAME>

Skill assembly

A skill assembly defines the skills and skill versions installed on all nodes in a cohort.

The default skill assembly is called sample-skill-assembly and includes the following skills:

  • Chef Infra Client interpreter skill
  • Courier Runner skill
  • Gohai skill
  • Inspec interpreter skill
  • Restart interpreter skill
  • Shell interpreter skill

sample-skill-assembly includes the latest versions of all skills:

  • Default skill assembly
    {
  "name": "sample-skill-assembly",
  "skills": [
    {
      "action": "add",
      "skill": {
        "name": "courier-runner",
        "channel": "stable",
        "value": ["1.5.3"]
      }
    },
    {
      "action": "add",
      "skill": {
        "channel": "stable",
        "name": "chef-gohai",
        "value": ["1.2.15"]
      }
    },
    {
      "action": "add",
      "skill": {
        "name": "shell-interpreter",
        "channel": "stable",
        "value": ["1.0.6"]
      }
    },
    {
      "action": "add",
      "skill": {
        "name": "inspec-interpreter",
        "channel": "stable",
        "value": ["1.0.8"]
      }
    },
    {
      "action": "add",
      "skill": {
        "name": "restart-interpreter",
        "channel": "stable",
        "value": ["1.0.5"]
      }
    },
    {
      "action": "add",
      "skill": {
        "name": "chef-client-interpreter",
        "channel": "stable",
        "value": ["1.0.8"]
      }
    }
  ]
}

Skill override settings

Each skill has global default settings that define how the skill works and apply to all nodes unless overridden by the override settings. Override settings override global default settings and apply to all nodes enrolled in a cohort.

By default, Chef 360 Platform adds the following override settings for the Courier Runner and Gohai skills to the sample-node-cohort cohort:

  • Default override settings
    {
  "name":"sample-node-setting",
  "skills":[
    {
      "skillName":"chef-gohai",
      "settings":[
        {
          "name":"log_level",
          "value":"info"
        },
        {
          "name":"log_file_path",
          "value":"/hab/svc/chef-gohai/logs/logs.log"
        },
        {
          "name":"log_to_file",
          "value": true
        },
        {
          "name":"log_to_stdout",
          "value": false
        },
        {
          "name":"poll_interval",
          "value":"3600s"
        },
        {
          "name":"max_size",
          "value":"100MB"
        },
        {
          "name":"retention_days",
          "value":"7"
        },
        {
          "name":"is_log_retention",
          "value":"true"
        }
      ]
    },
    {
      "skillName":"courier-runner",
      "settings":[
        {
          "name":"credentials_api_key",
          "value":""
        },
        {
          "name":"credentials_api_secret",
          "value":""
        },
        {
          "name":"shell_interpreter",
          "value":"chef-platform/shell-interpreter"
        },
        {
          "name":"restart_interpreter",
          "value":"chef-platform/restart-interpreter"
        },
        {
          "name":"inspec_interpreter",
          "value":"chef-platform/inspec-interpreter"
        },
        {
          "name":"chef_client_interpreter",
          "value":"chef-platform/chef-client-interpreter"
        },
        {
          "name":"log_dir",
          "value":"/hab/svc/courier-runner/logs"
        },
        {
          "name":"log_format",
          "value":"json"
        },
        {
          "name":"log_level",
          "value":"debug"
        },
        {
          "name":"log_output",
          "value":"file"
        },
        {
          "name":"max_size",
          "value":"100MB"
        },
        {
          "name":"retention_days",
          "value":"7"
        },
        {
          "name":"is_log_retention",
          "value":"true"
        },
        {
          "name":"queue_provider",
          "value":"0"
        },
        {
          "name":"reporter_authentication_type",
          "value":"basic"
        },
        {
          "name":"reporter_dir",
          "value":"/hab/svc/courier-runner/data"
        },
        {
          "name":"reporter_host_url",
          "value":""
        },
        {
          "name":"reporter_interval_in_sec",
          "value":"3"
        },
        {
          "name":"reporter_name",
          "value":"server"
        },
        {
          "name":"reporter_retry_interval_in_sec",
          "value":"4"
        },
        {
          "name":"reporter_total_retry_duration_in_min",
          "value":"2"
        }
      ]
    }
  ]
}

More information

Next step

Thank you for your feedback!

×