Usage
- Managing Sessions with Peak-SDK
- Sessions
- Importing and defining a custom
Session
objects for use within clients- This custom
Session
object can be passed when creating newclients
of anykind
. - The main purpose of this is to allow for the use of custom
Session
objects when working across multiple tenants simultaneously. - Multi-Environment usage example with a
Workflow
client - The default behavior is to pick up arguments from the user’s environment.
- This custom
- Importing and defining a custom
- Sessions
- 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 - Create or update a
image version
- 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
- Import the
- 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 - Modify the payload and update the existing
workflow
resource viapatch-workflow
- Create or update a
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 aworkflow
resource
- Import the workflow resource module and instantiate a
- 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 newversion
by uploading a new file - Update an
artifact
resource’s existingmetadata
- Download a versioned
artifact
from an existingartifact
resource - Delete an
artifact
version
from an existingartifact
resource - Delete an
artifact
resource along with all itsversion
(s)
- Import the artifact resource module and instantiate an
- 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 - Create or update a
Webapp
resource - Delete an existing
Webapp
resource - Describe an existing
Webapp
resource
- Import the webapps resource module and instantiate a
- Image 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 anapp-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 existingapp-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)
- Import the press app module and Instantiate a
- 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 ablock-spec
and iterate over them - Create a new
deployment
from a specificblock-spec
’srelease
- 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’srelease
(s)
- Import the press block module and Instantiate a
- Press Deployments
- Press Specs
- Press Apps
- Managing Auto-Pagination when available with Peak-SDK
- Using Templates in Peak-SDK and Peak-CLI
- Using Compression for Artifacts in Peak-SDK and Peak-CLI
- Creating Apps and Blocks via SDK
- Creating Images, Workflows and Webapps via SDK