peak-sdk
  • Usage
    • Managing Sessions with Peak-SDK
      • Sessions
        • Importing and defining a custom Session objects for use within clients
          • Multi-Environment usage example with a Workflow client
          • The default behavior is to pick up arguments from the user’s environment.
    • Interacting with peak resource services
      • Image resource
        • Import the image resource module and instantiate the client
        • List all existing image(s) and iterate over them
        • List all existing image version(s) and iterate over them
        • Create a new image resource
        • Create a new image version resource
        • Describe an existing image resource
        • Describe an existing version resource
        • Update an existing image version resource
        • List all builds in an existing image resource and iterate over them
        • Delete an existing image version resource
        • Delete an existing image resource
      • Workflows resource
        • Import the workflow resource module and instantiate a workflow-service client
        • List all existing workflow(s) and iterate over them
        • Prepare the payload and submit a new workflow resource for creation
        • Modify the payload and update the existing workflow resource
        • Describe an existing workflow resource
        • Delete an existing workflow resource
        • List all executions of a workflow resource and iterate over them
        • Schedule an immediate execution for a workflow
        • Get all available resource templates for a workflow resource
        • Get default resource template for a workflow resource
      • Artifacts resource
        • Import the artifact resource module and instantiate an artifact-service client
        • Create a new artifact resource by uploading a file
        • List all existing artifact(s) and iterate over them
        • Describe an existing artifact
        • Update an artifact resource with a new version by uploading a new file
        • Update an artifact resource’s existing metadata
        • Download a versioned artifact from an existing artifact resource
        • Delete an artifact version from an existing artifact resource
        • Delete an artifact resource along with all its version(s)
      • Webapps Resource
        • Import the webapps resource module and instantiate a webapps-service client
        • List all existing webapps(s) and iterate over them
        • Prepare the payload and submit a new Webapp resource for creation
        • Modify the payload and update the existing Webapp resource
        • Delete an existing Webapp resource
        • Describe an existing Webapp resource
    • Interacting with press framework services
      • Press Apps
        • Import the Press-App module and Instantiate a Press-App Client
        • Prepare an app-spec payload and create an app-spec
        • List created app-spec(s) and iterate over them
        • Describe an already existing app-spec
        • Update an app-spec’s metadata
        • Create a new app-spec release with updated config and release
        • Describe the app-spec release
        • List all app-spec release(s) and iterate over them
        • Create a new deployment from an existing app-spec release
        • List all existing deployment(s) and iterate over them
        • Describe an existing deployment
        • Update an existing deployment’s metadata
        • Delete an existing deployment
        • Delete an existing app-spec with all its release(s)
      • Press Blocks
        • Import the Press-Block module and Instantiate a Press-Block Client
        • Prepare payload and create a new workflow block-spec
        • Prepare payload and create a new webapp block-spec
        • List created block-spec(s) and iterate over them
        • Describe an already existing block-spec
        • Update the metadata and discoverability of a block-spec
        • Create a new workflow block-spec release with updated config and release
        • Create a new webapp block-spec release with updated config and release
        • Describe the block-spec release
        • List all release(s) in a block-spec and iterate over them
        • Create a new deployment from a specific block-spec’s release
        • List all existing deployment(s) and iterate over them
        • Describe a block deployment
        • Update an existing deployment’s metadata
        • Delete a block deployment
        • Delete an existing block-spec with all it’s release(s)
      • Press Deployments
        • Import the Press-Deployment module and Instantiate a Press-Deployment Client
        • List all App deployment(s) and Block deployment(s) and iterate over them
      • Press Specs
        • Import the Press-Spec module and Instantiate a Press-Spec Client
        • List all App spec(s) and Block spec(s) and iterate over them
        • List all deployment(s) for an existing app-spec release
    • Managing Auto-Pagination when available with Peak-SDK
      • Client Side Auto-Pagination
        • Import the Press-App module and Instantiate a Press-App Client
        • List created app-spec(s) and iterate over them using auto-pagination with return_iterator=True
        • List created app-spec(s) with auto-pagination disabled
    • Using Templates in Peak-SDK and Peak-CLI
      • Getting familiar with Templates
        • Using template_loader along with your own code.
        • Using template_loader with cli commands.
          • Visualizing the template loading logic used within cli commands
        • Usage Examples
          • Passing parameters in bulk.
          • Passing parameters one by one.
          • The recommended way.
          • A short guide to parameter conventions used within the cli.
    • Using Compression for Artifacts in Peak-SDK and Peak-CLI
      • Why do we need Artifacts and Compression
        • Usage Examples
          • Basic usage with path and ignore_files
          • Usage without ignore_files
          • Compress without ignore_files and a missing .dockerignore
          • Compress without both ignore_files and .dockerignore
          • Usage with multiple ignore files
          • The recommended way
  • SDK Reference
    • Sessions
    • Compression
    • Templating
      • API Reference
      • CLI Reference
    • Resources
      • Workflow
        • Workflow Client
      • Image
        • Image Client
      • Artifact
        • Artifact Client
      • Webapp
        • Webapp Client
    • Press
      • Press-App
        • Press-App Client
      • Press Blocks
        • Press Blocks Client
      • Press-Spec
        • Press-Spec Client
      • Press-Deployment
        • Press-Deployment Client
  • CLI
  • Contributor Guide
    • How to update this repository
    • How to report a bug
    • How to request a feature
    • How to set up your development environment
    • How to test the project
    • Resolving false positives in detect-secrets pre-commit scans
    • How to submit changes
  • Code of Conduct
    • Our Pledge
    • Our Standards
    • Enforcement Responsibilities
    • Scope
    • Enforcement
    • Enforcement Guidelines
      • 1. Correction
      • 2. Warning
      • 3. Temporary Ban
      • 4. Permanent Ban
    • Attribution
  • License
  • Changelog
    • [0.0.6]
    • [0.0.5]
    • [0.0.4]
    • [0.0.3]
peak-sdk
  • SDK Reference
  • Press

Press

  • Press-App
    • Press-App Client
  • Press Blocks
    • Press Blocks Client
  • Press-Spec
    • Press-Spec Client
  • Press-Deployment
    • Press-Deployment Client
Previous Next

© Copyright 2024, Peak AI.

Built with Sphinx using a theme provided by Read the Docs.
Other Versions v: v0.0.6
Tags
latest
v0.0.5
v0.0.6
v1.0.0
v1.1.0
v1.10.0
v1.11.0
v1.12.0
v1.13.0
v1.14.0
v1.15.0
v1.15.1
v1.16.0
v1.16.1
v1.17.0
v1.2.0
v1.2.1
v1.3.0
v1.4.0
v1.5.0
v1.6.0
v1.7.0
v1.8.0
v1.9.0