cheflib package

Subpackages

• cheflib.entities package
  • Submodules
  • cheflib.entities.base module
    • Entity
      • Entity.data
      • Entity.delete()
      • Entity.from_data()
      • Entity.name
    • EntityManager
      • EntityManager.filter()
  • cheflib.entities.client module
    • Client
      • Client.create_key()
      • Client.delete_key_by_name()
      • Client.expiration_date
      • Client.get_key_by_name()
      • Client.keys
      • Client.org_name
      • Client.private_key
      • Client.public_key
      • Client.reregister()
      • Client.validator
  • cheflib.entities.client_key module
    • ClientKey
      • ClientKey.expiration_date
      • ClientKey.expired
      • ClientKey.public_key
  • cheflib.entities.cookbook module
    • Cookbook
      • Cookbook.versions
  • cheflib.entities.databag module
    • DataBag
      • DataBag.create_item()
      • DataBag.get_item_by_name()
      • DataBag.get_item_names
  • cheflib.entities.databagitem module
    • DataBagItem
      • DataBagItem.encrypted
      • DataBagItem.secret
    • b64_chunker()
  • cheflib.entities.environment module
    • Environment
      • Environment.cookbook_versions
      • Environment.default_attributes
      • Environment.description
      • Environment.override_attributes
  • cheflib.entities.node module
    • Node
      • Node.automatic
      • Node.chef_environment
      • Node.default
      • Node.ip_address
      • Node.normal
      • Node.override
      • Node.run_list
  • cheflib.entities.role module
    • Role
  • Module contents

Submodules

cheflib.cheflib module

Main code for cheflib.

class cheflib.cheflib.Chef(endpoint: str, organization: str, user_id: str, private_key_contents: str, client_version: str = '12.0.2', authentication_version: str = '1.3', api_version: int = 1)

Bases: object

Chef api library.

property clients: EntityManager

List all clients.

Returns:

Generator for all clients

property cookbooks: EntityManager

List all cookbooks.

Returns:

Generator for all cookbooks

create_client(name: str, data: dict | None = None) → Client | None

Create a client, with specified.

Parameters:

• name – string, name of the client

• data – (optional) dictionary, containing additional attributes that will be added to the client

Returns:

New client

create_data_bag(name: str) → DataBag | None

Create a data bag.

Parameters:

name – string, name of the data bag

Returns:

New data bag

create_environment(name: str, data: dict | None = None) → Environment

Create a environment, with specified name.

Parameters:

• name – string, name of the environment

• data – (optional) dictionary, containing additional attributes that will be added to the environment

Returns:

New environment

create_node(name: str, data: dict | None = None) → Node

Create a node, with specified name.

Parameters:

• name – string, Name of the node

• data – (optional) dictionary, containing additional attributes that will be added to the node

Returns:

New node

create_role(name: str, data: dict | None = None) → Role

Create a role, with specified name.

Parameters:

• name – string, name of the role

• data – (optional) dictionary, containing additional attributes that will be added to the role.

Returns:

New role

property data_bags: EntityManager

List all data bags.

Returns:

Generator for all data bags

delete_client_by_name(name: str) → bool

Deletes a client by name.

Parameters:

name – string, name of the client

Returns:

True if deletion succeeded or False if deletion failed

delete_environment_by_name(name: str) → bool

Delete environment with specifief name.

Parameters:

name – string, name of environment

Returns:

True if deletion succeeded or False if deletion failed

delete_node_by_name(name: str) → bool

Delete node with specified name.

Parameters:

name – string, name of the node

Returns:

True if deletion succeeded or False if deletion failed

delete_role_by_name(name: str) → bool

Delete role with specified name.

Parameters:

name – string, name of the role

Returns:

True if deletion succeeded or False if deletion failed

property environments: EntityManager

List all environments.

Returns:

Generator for all environments

get_client_by_name(name: str) → Client

Gets a client by name.

Parameters:

name – string, name of the client

Returns:

First client with specified name

get_data_bag_by_name(name: str) → DataBag

Gets a data bag by name.

Parameters:

name – string, name of the data bag

Returns:

First data bag with specified name

get_data_bag_item_by_name(bag_name: str, name: str, secret: bytes | None = None) → DataBag

Gets a data bag item by name.

Parameters:

• bag_name – string, name of the data bag

• name – string, name of the item

• secret – (optional) bytes, secret key to encrypt/decrypt the data bag

Returns:

Data bag item with specified name

get_environment_by_name(name: str) → Environment

Get environment with specified name.

Parameters:

name – string, name of the environment

Returns:

First environment with specified name

get_node_by_ip_address(ipaddress: str) → Node

Get node with specified IP address.

Parameters:

ipaddress – string, IP address of the node

Returns:

First node with specified IP address

get_node_by_name(name: str) → Node

Get node with specified name.

Parameters:

name – string, name of the node

Returns:

First node with specified name

get_role_by_name(name: str) → Role

Get role with specified name.

Parameters:

name – string, name of the role

Returns:

First role with specified name

property nodes: EntityManager

List all nodes.

Returns:

Generator for all nodes

raw(uri, method='get', **kwargs)

Raw API calls to chef API.

See https://docs.chef.io/workstation/knife_raw/ for more details.

Parameters:

• uri – string, uri part of the API call

• method – (optional) string, GET, PUT, DELETE or POST

• **kwargs – (optional) additional keyword arguments

Returns:

JSON response from chef API

property roles: EntityManager

List all roles.

Returns:

Generator for all roles

search_nodes(query: str = '*:*', keys: dict | None = None)

Search nodes, full and partial search supported.

When a keys dictionary is provided, only those attributes will be returned. See https://docs.chef.io/chef_search/ for more details.

Parameters:

• query – (optional) string containing the search query

• keys – (optional) dictionary, containing the returned attributes (partial search)

Returns:

Generator for all nodes matching the search

cheflib.cheflibexceptions module

Custom exception code for cheflib.

exception cheflib.cheflibexceptions.CreateFailed

Bases: Exception

Create failed exception.

exception cheflib.cheflibexceptions.DeleteFailed

Bases: Exception

Delete failed exception.

exception cheflib.cheflibexceptions.InvalidObject

Bases: Exception

Invalid object exception.

exception cheflib.cheflibexceptions.InvalidSearchIndex

Bases: Exception

Invalid search index exception.

exception cheflib.cheflibexceptions.NodeNotFound

Bases: Exception

Node not found exception.

exception cheflib.cheflibexceptions.UnAuthorized

Bases: Exception

Unauthorized exception.

cheflib.configuration module

Module contents

cheflib package.

Import all parts from cheflib here