Advanced Concepts of Orchestration API V1 in Puppet

GET /plans

Lists every known plan in a particular setting.

Request format

You can use the standard URI path to query plans in the production environment when submitting Forming orchestrator API requests to this endpoint, such as
 

https://orchestrator.example.com:8143/orchestrator/v1/plans

If you want to query the plans of any other environment, you must use the environment option to identify that environment. 

Response format

A JSON object with an environment object and an items array makes up the response.
 

These keys are part of the environment object:

Name: The environment that the request requested.
 

code id: Must be a distinct string or null. The code id is used by Puppet Server to locate the file resource version present in a given environment at the time a catalog was created. The documentation for Puppet Static catalogs provides more information about code id.
 

Each plan in the environment is represented by a single JSON object in the items array. These keys are used by each plan object:

As an illustration, the following response outlines three plans for the production environment:

{
  "environment": {
    "name": "production",
    "code_id": null
  },
  "items": [
    {
      "id": "https://orchestrator.example.com:8143/orchestrator/v1/plans/profile/firewall",
      "name": "profile::firewall",
      "permitted": true
    },
    {
      "id": "https://orchestrator.example.com:8143/orchestrator/v1/plans/profile/rolling_update",
      "name": "profile::rolling_update",
      "permitted": true
    },
    {
      "id": "https://orchestrator.example.com:8143/orchestrator/v1/plans/canary/random",
      "name": "canary::random",
      "permitted": false
    }
  ]
}

Error responses

The Orchestrator API error responses include error information in the kind key if there is a problem:

GET /plans/<module>/<plan-name>

Find out exact plan details, including metadata. The GET /plans endpoint does not offer as much information as this endpoint does.

Request Format

The URI path must contain a specified module and plan name when Forming orchestrator API queries are made to this endpoint, for example:
 

GET "https://orchestrator.example.com:8143/orchestrator/v1/plans/profile/firewall"

To obtain module and plan names, use the GET /plans endpoint.

You can append the environment option to a plan to retrieve information about the plan in a particular environment if the plan is available in more than one environment. The endpoint uses production as the default value if you don't specify this argument. For instance, this request obtains information on the development environment's firewall plan:
 

GET "https://orchestrator.example.com:8143/orchestrator/v1/plans/profile/firewall?environment=development".

Response format

These keys are used in the response's JSON object, which contains details on the requested plan:

Example

{
  "id": "https://orchestrator.example.com:8143/orchestrator/v1/plans/package/install",
  "name": "canary::random",
  "environment": {
    "name": "production",
    "code_id": null
  },
  "metadata": {},
  "permitted": true
}

Error responses

The Orchestrator API error responses include error information in the kind key if there is a problem:

Check out this problem - Smallest Distinct Window.

Frequently Asked Questions

What purpose serves the puppet?

An open-source tool for managing and deploying software configuration is called Puppet. The most popular operating systems for controlling numerous application servers at once are Linux and Windows.

What is the most fundamental puppet modeling unit?

Resources serve as the fundamental building block for modeling system setups.

What are the functions of a puppet?

Infrastructure automation, automated provisioning, task management, code management, visualization, and reporting are just a few of Puppet's features.

What does a puppet node mean?

A section of Puppet code known as a node definition also called a node statement, is only present in the catalogs of matching nodes.

Conclusion

In this article, we have extensively discussed Advanced Concepts of Orchestration API V1 in Puppet.

We hope this blog has helped you enhance your knowledge. If you would like to learn more. Check out our articles on AWS, AWS Certification, and Ansible vs Puppet. Practice makes a man perfect. To practice and improve yourself in the interview. You can check out Top 100 SQL problems, Interview experience, Coding interview questions, and the Ultimate guide path for interviews.