feat(release): v1.14.0 discovery and conf pages
This commit is contained in:
@@ -0,0 +1,64 @@
|
||||
# Plugins & Scheduler
|
||||
|
||||
The SSO Manager includes a flexible background task runner and discovery system. Plugins are defined statically in your deployment configuration (`sso-secrets.js`) and run based on their defined `cron` schedule.
|
||||
|
||||
## Writing Custom Plugins
|
||||
|
||||
You can write custom plugins to discover resources, manage internal state, or run automated scripts. Plugins must be placed in the `plugins/discovery/` directory of the SSO Manager node codebase.
|
||||
|
||||
A plugin file must export a `discover` method.
|
||||
|
||||
**Example Plugin (`plugins/discovery/my_plugin.js`):**
|
||||
|
||||
```javascript
|
||||
module.exports = {
|
||||
discover: async function(config) {
|
||||
// The config object contains any keys passed in sso-secrets.js for this plugin.
|
||||
|
||||
// Perform discovery logic, hit external APIs, etc.
|
||||
const resources = [
|
||||
{
|
||||
slug: 'my-custom-resource-1',
|
||||
name: 'My Resource 1',
|
||||
kind: 'Host',
|
||||
metadata: {
|
||||
ip: '10.0.0.100',
|
||||
source: 'My Custom Plugin'
|
||||
}
|
||||
}
|
||||
];
|
||||
|
||||
// Return the discovered resources array. The discovery reconciler will
|
||||
// automatically save these to the Network Discovery database.
|
||||
return resources;
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## Configuring Plugins
|
||||
|
||||
In your `sso-secrets.js` file, add your plugin to the `discovery.plugins` object:
|
||||
|
||||
```javascript
|
||||
module.exports = {
|
||||
// ...
|
||||
discovery: {
|
||||
plugins: {
|
||||
my_plugin: {
|
||||
enabled: true,
|
||||
cron: "0 * * * *", // Run every hour
|
||||
my_custom_key: "my_custom_value" // Passed to the config argument in discover()
|
||||
}
|
||||
}
|
||||
}
|
||||
// ...
|
||||
};
|
||||
```
|
||||
|
||||
### Overriding Timing and Enable/Disable
|
||||
|
||||
From the **Plugins & Scheduler** tab in the Directory Dashboard, you can override the schedule and enable/disable state for each plugin. These overrides take precedence over `sso-secrets.js` and are stored internally.
|
||||
|
||||
## Scheduler Internals
|
||||
|
||||
The scheduler uses BullMQ backed by Redis to manage execution. It automatically performs garbage collection on stale network resources (resources not updated in > 7 days) and triggers your plugins at the defined intervals.
|
||||
@@ -0,0 +1,38 @@
|
||||
# Vault Secrets Management
|
||||
|
||||
The Vault Secrets feature integrates with OpenBao to provide a secure key-value store for your environment. It allows you to store sensitive information like passwords, API keys, and credentials, ensuring they are encrypted and access-controlled.
|
||||
|
||||
## Usage
|
||||
|
||||
You can access the Vault UI from the application's top navigation bar.
|
||||
|
||||
### Creating Secrets
|
||||
|
||||
1. Click on the **New Secret** button.
|
||||
2. Enter a **Secret Path**. This acts as the name/identifier of your secret (e.g., `db-credentials`).
|
||||
3. Enter the **Secret Data** in JSON format. For example:
|
||||
```json
|
||||
{
|
||||
"username": "admin",
|
||||
"password": "supersecretpassword123"
|
||||
}
|
||||
```
|
||||
4. Click **Save Secret**.
|
||||
|
||||
### Reading and Editing Secrets
|
||||
|
||||
* To view a secret, click on its name in the **Secrets List**.
|
||||
* To update an existing secret, select it and click the **Edit** button. You can then modify the JSON data and save your changes.
|
||||
|
||||
### OpenBao Integration
|
||||
|
||||
The secrets are stored in an OpenBao backend configured in development mode. The default KV (Key-Value) version 2 engine is mounted at `secret/`. The built-in UI uses the `/api/vault/secret/` API endpoints to interact with OpenBao.
|
||||
|
||||
## API Access
|
||||
|
||||
If you need to programmatically access the secrets, you can interact directly with the OpenBao API using the root token (in dev mode):
|
||||
|
||||
```bash
|
||||
# Example: Read a secret via the API
|
||||
curl -H "X-Vault-Token: root" -H "Authorization: Bearer <your-sso-token>" http://<your-sso-host>/api/vault/secret/data/<your-secret-path>
|
||||
```
|
||||
Reference in New Issue
Block a user