edge_stacks

Create an EdgeStack from a git repository

Access policy: administrator

post/edge_stacks/create/repository

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/edge_stacks/create/repository
  • Auth
    • API key in header X-API-KEY
    • or API key in header Authorization

Query parameters

dryrunstring

if true, will not create an edge stack, but just will check the settings and return a non-persisted edge stack object

Request body

DeploymentType0 | 1
EdgeGroupsinteger[] required

List of identifiers of EdgeGroups

FilePathInRepositorystring

Path to the Stack file inside the Git repository

Namestring required

Name of the stack Max length: 255 Name must only contains lowercase characters, numbers, hyphens, or underscores Name must start with a lowercase character or number Example: stack-name or stack_123 or stackName

Registriesinteger[]

List of Registries to use for this stack

RepositoryAuthenticationboolean

Deprecated: Use SourceID instead. Use basic authentication to clone the Git repository.

RepositoryPasswordstring

Deprecated: Use SourceID instead. Password used in basic authentication.

RepositoryReferenceNamestring

Reference name of a Git repository hosting the Stack file

RepositoryURLstring

Deprecated: Use SourceID instead. URL of a Git repository hosting the Stack file.

RepositoryUsernamestring

Deprecated: Use SourceID instead. Username used in basic authentication.

SourceIDinteger

SourceID references an existing Source for git credentials/URL. When set, the inline URL and authentication fields are ignored.

TLSSkipVerifyboolean

Deprecated: Use SourceID instead. TLSSkipVerify skips SSL verification when cloning the Git repository.

UseManifestNamespacesboolean

Uses the manifest's namespaces instead of the default one

Example request

{
  "EdgeGroups": [
    1
  ],
  "FilePathInRepository": "docker-compose.yml",
  "Name": "stack-name",
  "RepositoryAuthentication": true,
  "RepositoryPassword": "myGitPassword",
  "RepositoryReferenceName": "refs/heads/master",
  "RepositoryURL": "https://github.com/openfaas/faas",
  "RepositoryUsername": "myGitUsername",
  "SourceID": 1
}

Response

OK

CreatedBystring

The username which created this stack

CreatedByUserIdstring

The username id which created this stack

CreationDateinteger

StatusArray map[EndpointID][]EdgeStackStatus json:"StatusArray"

DeploymentType0 | 1
EdgeGroupsinteger[]
EntryPointstring
Idinteger

EdgeStack Identifier

ManifestPathstring
Namestring
NumDeploymentsinteger
ProjectPathstring
Statusobject
UseManifestNamespacesboolean

Uses the manifest's namespaces instead of the default one

Versioninteger

Example response

{
  "CreatedBy": "admin",
  "CreatedByUserId": "1",
  "Id": 1
}

Changes

No recorded changes to this operation across all 21 revisions of this API.