Skip to main content

Plugin

In this section, you will find some Plugin details.

A Plugin serves as an extension that enhances an application's capabilities. It adheres to established standards and best practices. In the context of StackSpot, a Plugin is always associated with a Studio. It's possible to have Plugins with the same name, but they must belong to different Studios.

Each Plugin version remains immutable. If you wish to make modifications to a Plugin, you are required to publish a new version of it. These versions of a Plugin adhere to semantic versioning (SemVer) principles.

There are two Plugin types:

  • App: Application Plugin;
  • Infra: Infrastructure Plugin that provides resources to an Application.

Plugin Types

Application Plugin (App)

The App Plugin helps write an Application.

See the YAML:

YAML Structure

schema-version: v2 #required
kind: plugin #required
metadata:
  name: lambda-new-endpoint #required
  display-name: Endpoint para Lambda  #required
  description: Add new endpoint to an existing Lambda API. #required
  version: 1.0.0 #required
  picture: plugin.png #optional 
spec:
  type: app #required
  compatibility:
    - python
  about: docs/about.md #optional #warning
  implementation: docs/implementation.md #optional #warning
  release-notes: docs/release-notes-1.0.0.md #optional #warning
  requirements: docs/requirements.md #optional 
  technologies: # Ref: https://docs.stackspot.com/create-use/create-content/yaml-files/plugin-yaml/#technologies
    - Api
  requires: 
    connections:
      - type: aws-api-gateway-conn
        alias: alias-test
      - type: aws-cloud-front-conn
        alias: alias-test2
      - type: aws-api-gateway-conn
        alias: same-conn-alias-test1
  inputs: #optional
    - label: Type name of your resource
      name: resource
      type: text
      required: true
      default: Client
      pattern: '([A-Z][a-z]+)+'
      help: 'Inform your resource name (e.g.: Client)'
    - label: Choose http method of new endpoint
      name: method
      type: select
      items:
        - GET
        - POST
        - PUT
        - DELETE
        - PATCH
      default: GET
      required: true
      help: 'Inform the method of the endpoint (e.g.: post or delete)'

Infrastructure Plugin (Infra-plugin)

It is a Plugin that provisions resources to an Application.

See an example:

  • You want to create an Application with a database. The Infra Plugin creates and deploys a database structure for it.

The Infra Plugin depends on the App Plugin because it supports the Application.

YAML Structure

schema-version: v2 #required
kind: plugin #required
metadata:
  name: lambda-new-endpoint #required
  display-name: Endpoint para Lambda  #required
  description: Add new endpoint to an existing Lambda API. #required
  version: 1.0.0 #required
  picture: plugin.png
spec:
  type: infra #required 
  compatibility:
    - python
  about: docs/about.md
  implementation: docs/implementation.md
  release-notes: docs/release-notes-1.0.0.md
  requirements: docs/requirements.md
  technologies: # Ref: https://docs.stackspot.com/create-use/create-content/yaml-files/plugin-yaml/#technologies
    - Api
  runtime: #required
    environment: #required
      - terraform-1-4
      - aws-cli-2
      - git-2
  requires: #required
    connections: #required
      - type: aws-cloud-front-conn
        alias: alias-1
  generates: #required
    connections: #required 
      - type: aws-api-gateway-conn
        alias: alias-2

Next Steps

For more information about Plugins, follow the guides below:

Was this page helpful?