@adobe/aio-lib-cloudmanager v3.1.0

Adobe I/O Cloud Manager Library

JavaScript SDK wrapping the Adobe Cloud Manager API.

Installing

$ npm install @adobe/aio-lib-cloudmanager

Usage

1) Initialize the SDK

const sdk = require('@adobe/aio-lib-cloudmanager')

async function sdkTest() {
  //initialize sdk
  const client = await sdk.init('<orgId>', 'x-api-key', '<valid auth token>')
}

2) Call methods using the initialized SDK

const sdk = require('@adobe/aio-lib-cloudmanager')

async function sdkTest() {
  // initialize sdk
  const client = await sdk.init('<orgId>', 'x-api-key', '<valid auth token>')

  // call methods
  try {
    // get... something
    const result = await client.listPrograms()
    console.log(result)

  } catch (e) {
    console.error(e)
  }
}

Classes

Functions

Typedefs

CloudManagerAPI

This class provides methods to call your Cloud Manager APIs. Before calling any method initialize the instance by calling the init method on it with valid values for orgId, apiKey and accessToken

Kind: global class

• CloudManagerAPI
  • .orgId : string
  • .apiKey : string
  • .accessToken : string
  • .baseUrl : string
  • .addIpAllowlistBinding(programId, ipAllowlistId, environmentId, service) ⇒ Promise.<object>
  • .advanceCurrentExecution(programId, pipelineId) ⇒ Promise.<object>
  • .cancelContentFlow(programId, contentFlowId) ⇒ Promise.<object>
  • .cancelCurrentExecution(programId, pipelineId) ⇒ Promise.<object>
  • .createContentFlow(programId, environmentId, contentFlow) ⇒ Promise.<ContentFlow>
  • .createContentSet(programId, contentSet) ⇒ Promise.<ContentSet>
  • .createExecution(programId, pipelineId, mode) ⇒ Promise.<PipelineExecution>
  • .createIpAllowlist(programId, name, cidrBlocks) ⇒ Promise.<IPAllowedList>
  • .deleteContentSet(programId, contentSetId) ⇒ Promise.<object>
  • .deleteEnvironment(programId, environmentId) ⇒ Promise.<object>
  • .deleteIpAllowlist(programId, ipAllowlistId) ⇒ Promise.<object>
  • .deletePipeline(programId, pipelineId) ⇒ Promise.<object>
  • .deleteProgram(programId) ⇒ Promise.<object>
  • .downloadLogs(programId, environmentId, service, name, days, outputDirectory) ⇒ Promise.<Array.<DownloadedLog>>
  • .getContentFlow(programId, contentFlowId) ⇒ Promise.<ContentFlow>
  • .getContentSet(programId, contentSetId) ⇒ Promise.<ContentSet>
  • .getCurrentExecution(programId, pipelineId) ⇒ Promise.<PipelineExecution>
  • .getDeveloperConsoleUrl(programId, environmentId) ⇒ Promise.<string>
  • .getEnvironmentVariables(programId, environmentId) ⇒ Promise.<Array.<Variable>>
  • .getExecution(programId, pipelineId, executionId) ⇒ Promise.<PipelineExecution>
  • .getExecutionStepLog(programId, pipelineId, executionId, action, logFile, outputStream) ⇒ Promise.<object>
  • .getPipelineVariables(programId, pipelineId) ⇒ Promise.<Array.<Variable>>
  • .getQualityGateResults(programId, pipelineId, executionId, action) ⇒ Promise.<PipelineStepMetrics>
  • .init(orgId, apiKey, accessToken, baseUrl) ⇒ Promise.<CloudManagerAPI>
  • .invalidatePipelineCache(programId, pipelineId) ⇒ Promise.<object>
  • .listAvailableLogOptions(programId, environmentId) ⇒ Promise.<Array.<LogOptionRepresentation>>
  • .listContentFlows(programId) ⇒ Promise.<Array.<ContentFlow>>
  • .listContentSets(programId) ⇒ Promise.<Array.<ContentSet>>
  • .listEnvironments(programId) ⇒ Promise.<Array.<Environment>>
  • .listExecutions(programId, pipelineId, limit) ⇒ Promise.<Array.<PipelineExecution>>
  • .listIpAllowlists(programId) ⇒ Promise.<IPAllowedList>
  • .listPipelines(programId, options) ⇒ Promise.<Array.<Pipeline>>
  • .listPrograms() ⇒ Promise.<Array.<EmbeddedProgram>>
  • .removeIpAllowlistBinding(programId, ipAllowlistId, environmentId, service) ⇒ Promise.<object>
  • .setEnvironmentVariables(programId, environmentId, variables) ⇒ Promise.<object>
  • .setPipelineVariables(programId, pipelineId, variables) ⇒ Promise.<object>
  • .startExecution(programId, pipelineId, mode) ⇒ Promise.<string>
  • .tailExecutionStepLog(programId, pipelineId, action, logFile, outputStream) ⇒ Promise.<PipelineExecutionStepState>
  • .updateContentSet(programId, contentSetId, updatedContentSet) ⇒ Promise.<ContentSet>
  • .updateIpAllowlist(programId, ipAllowlistId, cidrBlocks) ⇒ Promise.<object>
  • .updatePipeline(programId, pipelineId, changes) ⇒ Promise.<Pipeline>

cloudManagerAPI.orgId : string

The organization id

Kind: instance property of CloudManagerAPI

cloudManagerAPI.apiKey : string

The api key from your integration

Kind: instance property of CloudManagerAPI

cloudManagerAPI.accessToken : string

The access token from your integration

Kind: instance property of CloudManagerAPI

cloudManagerAPI.baseUrl : string

The base URL for the API endpoint

Kind: instance property of CloudManagerAPI

cloudManagerAPI.addIpAllowlistBinding(programId, ipAllowlistId, environmentId, service) ⇒ Promise.<object>

Bind an IP Allow List to an environment

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.advanceCurrentExecution(programId, pipelineId) ⇒ Promise.<object>

Advance current execution

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.cancelContentFlow(programId, contentFlowId) ⇒ Promise.<object>

Cancel a content flow Cancels an in progress flow

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.cancelCurrentExecution(programId, pipelineId) ⇒ Promise.<object>

Cancel current execution

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.createContentFlow(programId, environmentId, contentFlow) ⇒ Promise.<ContentFlow>

Create content Set Flow for environment

Kind: instance method of CloudManagerAPI
Returns: Promise.<ContentFlow> - the created content flow representation

cloudManagerAPI.createContentSet(programId, contentSet) ⇒ Promise.<ContentSet>

Create a Content set

Kind: instance method of CloudManagerAPI
Returns: Promise.<ContentSet> - the created content set

cloudManagerAPI.createExecution(programId, pipelineId, mode) ⇒ Promise.<PipelineExecution>

Create a new execution for a pipeline, returning the execution.

Kind: instance method of CloudManagerAPI
Returns: Promise.<PipelineExecution> - the new execution

cloudManagerAPI.createIpAllowlist(programId, name, cidrBlocks) ⇒ Promise.<IPAllowedList>

Create IP Allow List

Kind: instance method of CloudManagerAPI
Returns: Promise.<IPAllowedList> - a truthy value

cloudManagerAPI.deleteContentSet(programId, contentSetId) ⇒ Promise.<object>

Delete Content Set

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.deleteEnvironment(programId, environmentId) ⇒ Promise.<object>

Delete an environment

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.deleteIpAllowlist(programId, ipAllowlistId) ⇒ Promise.<object>

Update the CIDR blocks of an IP Allow List

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.deletePipeline(programId, pipelineId) ⇒ Promise.<object>

Delete a pipeline

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy object

cloudManagerAPI.deleteProgram(programId) ⇒ Promise.<object>

Delete a program

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.downloadLogs(programId, environmentId, service, name, days, outputDirectory) ⇒ Promise.<Array.<DownloadedLog>>

Download log files from the environment to a specified directory.

Kind: instance method of CloudManagerAPI
Returns: Promise.<Array.<DownloadedLog>> - the list of downloaded logs

cloudManagerAPI.getContentFlow(programId, contentFlowId) ⇒ Promise.<ContentFlow>

Get Content Flow

Kind: instance method of CloudManagerAPI
Returns: Promise.<ContentFlow> - the Content Flow

cloudManagerAPI.getContentSet(programId, contentSetId) ⇒ Promise.<ContentSet>

Get Content Set

Kind: instance method of CloudManagerAPI
Returns: Promise.<ContentSet> - the content set

cloudManagerAPI.getCurrentExecution(programId, pipelineId) ⇒ Promise.<PipelineExecution>

Get the current execution for a pipeline

Kind: instance method of CloudManagerAPI
Returns: Promise.<PipelineExecution> - the execution

cloudManagerAPI.getDeveloperConsoleUrl(programId, environmentId) ⇒ Promise.<string>

Get the link to the developer console

Kind: instance method of CloudManagerAPI
Returns: Promise.<string> - the console url

cloudManagerAPI.getEnvironmentVariables(programId, environmentId) ⇒ Promise.<Array.<Variable>>

Get the list of variables for an environment

Kind: instance method of CloudManagerAPI
Returns: Promise.<Array.<Variable>> - the variables

cloudManagerAPI.getExecution(programId, pipelineId, executionId) ⇒ Promise.<PipelineExecution>

Get an execution for a pipeline

Kind: instance method of CloudManagerAPI
Returns: Promise.<PipelineExecution> - the execution

cloudManagerAPI.getExecutionStepLog(programId, pipelineId, executionId, action, logFile, outputStream) ⇒ Promise.<object>

Write step log to an output stream.

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.getPipelineVariables(programId, pipelineId) ⇒ Promise.<Array.<Variable>>

Get the list of variables for a pipeline

Kind: instance method of CloudManagerAPI
Returns: Promise.<Array.<Variable>> - the variables

cloudManagerAPI.getQualityGateResults(programId, pipelineId, executionId, action) ⇒ Promise.<PipelineStepMetrics>

Get the quality gate results for a pipeline step

Kind: instance method of CloudManagerAPI
Returns: Promise.<PipelineStepMetrics> - the execution

cloudManagerAPI.init(orgId, apiKey, accessToken, baseUrl) ⇒ Promise.<CloudManagerAPI>

Initializes a CloudManagerAPI object and returns it.

Kind: instance method of CloudManagerAPI
Returns: Promise.<CloudManagerAPI> - a CloudManagerAPI object

cloudManagerAPI.invalidatePipelineCache(programId, pipelineId) ⇒ Promise.<object>

Invalidate the cache for a pipeline

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy object

cloudManagerAPI.listAvailableLogOptions(programId, environmentId) ⇒ Promise.<Array.<LogOptionRepresentation>>

List the log options available for an environment

Kind: instance method of CloudManagerAPI
Returns: Promise.<Array.<LogOptionRepresentation>> - the log options for the environment

cloudManagerAPI.listContentFlows(programId) ⇒ Promise.<Array.<ContentFlow>>

List content flows for program

Kind: instance method of CloudManagerAPI
Returns: Promise.<Array.<ContentFlow>> - an array of content flows

cloudManagerAPI.listContentSets(programId) ⇒ Promise.<Array.<ContentSet>>

List Content Sets for program

Kind: instance method of CloudManagerAPI
Returns: Promise.<Array.<ContentSet>> - list of the content sets for the program

cloudManagerAPI.listEnvironments(programId) ⇒ Promise.<Array.<Environment>>

List environments for a program

Kind: instance method of CloudManagerAPI
Returns: Promise.<Array.<Environment>> - a list of environments

cloudManagerAPI.listExecutions(programId, pipelineId, limit) ⇒ Promise.<Array.<PipelineExecution>>

List the most recent executions for a pipeline

Kind: instance method of CloudManagerAPI
Returns: Promise.<Array.<PipelineExecution>> - the list of executions

cloudManagerAPI.listIpAllowlists(programId) ⇒ Promise.<IPAllowedList>

List the program's defined IP Allow Lists

Kind: instance method of CloudManagerAPI
Returns: Promise.<IPAllowedList> - - the IP Allow Lists

cloudManagerAPI.listPipelines(programId, options) ⇒ Promise.<Array.<Pipeline>>

Obtain a list of pipelines for the target program.

Kind: instance method of CloudManagerAPI
Returns: Promise.<Array.<Pipeline>> - an array of Pipelines

cloudManagerAPI.listPrograms() ⇒ Promise.<Array.<EmbeddedProgram>>

Obtain a list of programs for the target organization.

Kind: instance method of CloudManagerAPI
Returns: Promise.<Array.<EmbeddedProgram>> - an array of Programs

cloudManagerAPI.removeIpAllowlistBinding(programId, ipAllowlistId, environmentId, service) ⇒ Promise.<object>

Unbind an IP Allow List from an environment

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.setEnvironmentVariables(programId, environmentId, variables) ⇒ Promise.<object>

Set the variables for an environment

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.setPipelineVariables(programId, pipelineId, variables) ⇒ Promise.<object>

Set the variables for a pipeline

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.startExecution(programId, pipelineId, mode) ⇒ Promise.<string>

Deprecated

Start an execution for a pipeline, returning the url of the new execution

Kind: instance method of CloudManagerAPI
Returns: Promise.<string> - the execution url

cloudManagerAPI.tailExecutionStepLog(programId, pipelineId, action, logFile, outputStream) ⇒ Promise.<PipelineExecutionStepState>

Tail step log to an output stream.

Kind: instance method of CloudManagerAPI
Returns: Promise.<PipelineExecutionStepState> - the completed step state

cloudManagerAPI.updateContentSet(programId, contentSetId, updatedContentSet) ⇒ Promise.<ContentSet>

Update the content set definition.

The operation is a PUT, so the entire body has to be provided.

Kind: instance method of CloudManagerAPI
Returns: Promise.<ContentSet> - the updated content set

cloudManagerAPI.updateIpAllowlist(programId, ipAllowlistId, cidrBlocks) ⇒ Promise.<object>

Update the CIDR blocks of an IP Allow List

Kind: instance method of CloudManagerAPI
Returns: Promise.<object> - a truthy value

cloudManagerAPI.updatePipeline(programId, pipelineId, changes) ⇒ Promise.<Pipeline>

Update a pipeline

Kind: instance method of CloudManagerAPI
Returns: Promise.<Pipeline> - the new pipeline definition

getCurrentStep(execution) ⇒ PipelineExecutionStepState

Find the first non-finished step in a pipeline execution

Kind: global function
Returns: PipelineExecutionStepState - the step state or a falsy object if all steps are finished

getWaitingStep(execution) ⇒ PipelineExecutionStepState

Find the first waiting step in a pipeline execution

Kind: global function
Returns: PipelineExecutionStepState - the step state or a falsy object if no step is waiting

init(orgId, apiKey, accessToken, baseUrl) ⇒ Promise.<CloudManagerAPI>

Returns a Promise that resolves with a new CloudManagerAPI object.

Kind: global function
Returns: Promise.<CloudManagerAPI> - a Promise with a CloudManagerAPI object

EmbeddedProgram : object

A lightweight representation of a Program

Kind: global typedef
Properties

Pipeline : object

A representation of a CI/CD Pipeline

Kind: global typedef
Properties

PipelinePhase : object

Describes a phase of a pipeline

Kind: global typedef
Properties

PipelineExecution : object

A representation of an execution of a CI/CD Pipeline.

Kind: global typedef
Properties

PipelineExecutionStepState : object

Describes the status of a particular pipeline execution step for display purposes

Kind: global typedef
Properties

PipelineStepMetrics : object

Kind: global typedef
Properties

Metric : object

A representation of a specific metric generated by a CI/CD Pipeline step.

Kind: global typedef
Properties

Environment : object

A representation of an Environment known to Cloud Manager.

Kind: global typedef
Properties

Variable : object

A named value than can be set on an Environment or Pipeline

Kind: global typedef
Properties

ContentSet : object

A representation of a ContentSet custom

Kind: global typedef
Properties

ContentFlow : object

The Content Flow Execution

Kind: global typedef
Properties

LogOptionRepresentation : object

Kind: global typedef
Properties

IPAllowedListBinding : object

Describes an IP Allowed List Binding

Kind: global typedef
Properties

IPAllowedList : object

Describes an IP Allowed List

Kind: global typedef
Properties

ListPipelineOptions : object

Options to the listPipeline function

Kind: global typedef
Properties

DownloadedLog : object

Kind: global typedef
Properties

PipelineUpdate : object

Kind: global typedef
Properties

Debug Logs

LOG_LEVEL=debug <your_call_here>

Prepend the LOG_LEVEL environment variable and debug value to the call that invokes your function, on the command line. This should output a lot of debug data for your SDK calls.

Contributing

Contributions are welcome! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.