smallstep.agent.instance (0.0.1) — module

Install collection

Install with ansible-galaxy collection install smallstep.agent:==0.0.1

Add to requirements.yml

  collections:
    - name: smallstep.agent
      version: 0.0.1

Description

Manage a Smallstep Device Collection instance

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a Smallstep Device Collection instance
  smallstep.agent.instance:
    collection_slug: hotdog-production
    instance_id: i-0d69ab001748abd98
    instance_metadata:
        name: nginx-01
        role: webserver
        env: prod
    api_token: "eyJUzI1NiI..."
    state: present

Inputs

    
state:
    choices:
    - absent
    - present
    default: present
    description:
    - State of the instance.
    type: str

api_host:
    description: The Smallstep host used when connecting.
    env:
    - name: SMALLSTEP_API_HOST
    type: str

api_token:
    description:
    - The Smallstep API Token used when connecting.
    - Required.
    env:
    - name: SMALLSTEP_API_TOKEN
    type: str

instance_id:
    description:
    - The ID of the instance.
    - Example AWS i-0eebba999846bb1 EC2 instance ID
    - Example GCP 33322448555564760720 VM instance ID
    - Example Azure 6481a05f-1887-4156-ba64-4d1650811b48 This is the instances Managed
      Identity UUID
    - Example TPM urn ek sha256 RAzbOveN1Y45fYubuTxu5jOXWtOK1HbfZ7yHjBuWlyE This is the
      SHA256 hash of the endorsement key
    - Required.
    type: str

collection_slug:
    description:
    - The Device Collection slug of the instance.
    - This is the Device Collection you are adding the instance to.
    - Required.
    type: str

instance_metadata:
    default: {}
    description:
    - The metadata on the Device Collection instance.
    - A list of dictionaries Name nginx-01, role webserver, env prod
    elements: dict
    type: dict

Outputs

smallstep_instance:
  contains: null
  description: Manage Smallstep Collection Instances
  returned: Always
  smallstep_instance:
    collection_slug: hotdog-production
    fingerprint: 6a57e47f8aee2ff162415f9d592ccf52ab3681c964c66c122aadd1287ff57112
    instance_id: i-0d69ab001748abd98
    instance_metadata:
      Name: nginx-01
      demo_family: ubuntu
      driver: jdoss
      env: prod
      location: us-east-2
      role: webserver
      smallstep_collection: hotdog-production
    response:
      createdAt: '2023-10-06T17:43:16.878098+00:00'
      data:
        Name: smallstep-demo
        location: us-east-2
        smallstep_collection: hotdog-production
      id: i-0d69ab001748abd98
      updatedAt: '2023-10-06T17:43:16.878098+00:00'
    team: jdoss
  type: complex