Skip to content

Commit

Permalink
Plugin overview docs
Browse files Browse the repository at this point in the history
  • Loading branch information
traut committed Feb 15, 2024
1 parent 654e14a commit ec3371e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 15 deletions.
1 change: 1 addition & 0 deletions .github/styles/config/vocabularies/fabric-vocab/accept.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
GitHub
Fabric
boolean
namespace
20 changes: 5 additions & 15 deletions docs/plugins/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,11 @@ weight: 5

# Plugins

[TBD]
Fabric relies on plugins to implement data sources and content providers. To utilise a plugin's data sources and content providers, it must be installed by Fabric. The global configuration should specify all required plugins (see [Global configuration]({{< ref "../language/configs.md/#global-configuration" >}}) for the details). Additionally, some data sources and content providers require configuration (for example, API keys, URLs, credentials, etc).

Fabric relies on plugins called providers to interact with cloud providers, SaaS providers, and other APIs.
A plugin name consists of a namespace (a name of a plugin vendor) and a short name. For example, `blackstork/elasticsearch` plugin implements Elasticsearch client data source and is released by [BlackStork](https://blackstork.io).

Fabric configurations must declare which providers they require so that Fabric can install and use them. Additionally, some providers require configuration (like endpoint URLs or cloud regions) before they can be used.
## Where to get the plugins

What Providers Do
Each provider adds a set of resource types and/or data sources that Fabric can manage.

Every resource type is implemented by a provider; without providers, Fabric can't manage any kind of infrastructure.

Most providers configure a specific infrastructure platform (either cloud or self-hosted). Providers can also offer local utilities for tasks like generating random numbers for unique resource names.


Where Providers Come From
Providers are distributed separately from Fabric itself, and each provider has its own release cadence and version numbers.

The Fabric Registry is the main directory of publicly available Fabric providers, and hosts providers for most major infrastructure platforms.
Plugins are released and distributed independently from Fabric, with their own release cycle and version.
You can find a list of plugins released by BlackStork at the [Releases page](https://github.com/blackstork-io/fabric/releases) in Fabric GitHub.

0 comments on commit ec3371e

Please sign in to comment.