Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature]: extensibility api management #198

Closed
5 of 7 tasks
fredmaggiowski opened this issue Jun 19, 2024 · 0 comments · Fixed by #200, #199, #204 or #205
Closed
5 of 7 tasks

[Feature]: extensibility api management #198

fredmaggiowski opened this issue Jun 19, 2024 · 0 comments · Fixed by #200, #199, #204 or #205
Labels
enhancement New feature or request

Comments

@fredmaggiowski
Copy link
Member

fredmaggiowski commented Jun 19, 2024

Describe the feature

With Console v13 the Extensibility feature has been released and is currently only usable via API.

It would be extremely useful to be able to manage the extensions lifecycle from miactl.

I'd expect to run commands such as:

# create extension
miactl extensions apply [--extension-id=ext-id] -f extension-definition.json [--company-id=company-id]

# list registered extensions in company
miactl extensions list [--company-id=company-id]

# activate extension
miactl extensions activate --extension-id=ext-id [--company-id=company-id] [--project-id=project-id]

# delete extension
miactl extensions delete --extension-id=ext-id [--company-id=company-id]

Note

Flags within square brackets are meant to be optional as they may be taken from the current context


For the apply command the optional --extension-id will be used to distinguish between update and create


The extension definition file will map the available configurations for an extension and look something like the following:

{
  "name": "Deployer helper",
  "entry": "https://example.com/",
  "contexts": ["project"],
  "routes": [{
    "id": "react-app",
    "parentId": "workloads",
    "locationId": "runtime",
    "labelIntl": {
      "en": "SomeLabel"
      "it": "SomeLabelInItalian"
    },
    "destinationPath": "/",
    "order": 200,
    "icon": {
      "name": "PiHardDrives"
    }
  }]
}

Implementation progress

Code of Conduct

  • I agree to follow this project’s Code of Conduct
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
1 participant