Merge pull request #3776 from backstage/freben/catalog-schema-again
catalog-backend: flesh out and tweak the config schema
This commit is contained in:
Fredrik Adelöw
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@backstage/plugin-catalog-backend': patch
|
||||
---
|
||||
|
||||
Updated the config schema
|
||||
Vendored
+340
-196
@@ -17,226 +17,370 @@
|
||||
import { JsonValue } from '@backstage/config';
|
||||
|
||||
export interface Config {
|
||||
/** Configuration options for the catalog plugin */
|
||||
/**
|
||||
* Configuration options for the catalog plugin.
|
||||
*/
|
||||
catalog?: {
|
||||
/**
|
||||
* Rules to apply to catalog entities - accepts an array of objects with below attributes
|
||||
* Rules to apply to all catalog entities, from any location.
|
||||
*
|
||||
* An undefined list of matchers means match all, an empty list of
|
||||
* matchers means match none.
|
||||
*
|
||||
* This is commonly used to put in what amounts to a whitelist of kinds
|
||||
* that regular users of Backstage are permitted to register locations
|
||||
* for. This can be used to stop them from registering yaml files
|
||||
* describing for example a Group entity called "admin" that they make
|
||||
* themselves members of, or similar.
|
||||
*/
|
||||
rules?: Array<{
|
||||
/**
|
||||
* attr: 'allow' - accepts an array of string. e.g. [Component, API, Group, User, Template, Location]
|
||||
* Allow entities of these particular kinds.
|
||||
*
|
||||
* E.g. ["Component", "API", "Template", "Location"]
|
||||
*/
|
||||
allow: Array<string>;
|
||||
/**
|
||||
* opt-attr: 'locations' - accepts an array of key, value pair objects.
|
||||
* keys: 'target', 'type'
|
||||
* e.g.[{type: url, target: https://github.com}]
|
||||
*
|
||||
*/
|
||||
locations?: Array<{ [key: string]: string }>;
|
||||
}>;
|
||||
|
||||
/**
|
||||
* List of processor options and attributes
|
||||
*/
|
||||
processors?: {
|
||||
/**
|
||||
* Github processor configuration
|
||||
*/
|
||||
githubOrg?: {
|
||||
/**
|
||||
* attr: 'providers' - accepts an array of objects with below attributes
|
||||
*/
|
||||
providers: Array<{
|
||||
/**
|
||||
* attr: 'target' - accepts url string
|
||||
* e.g. https://ghe.example.net
|
||||
*/
|
||||
target: string;
|
||||
/**
|
||||
* opt-attr: 'apiBaseUrl' - accepts baseurl string
|
||||
* e.g. https://ghe.example.net/api
|
||||
*/
|
||||
apiBaseUrl?: string;
|
||||
/**
|
||||
* opt-attr: 'token' - secret token to authenticate
|
||||
* e.g. {"$env": "GITHUB_TOKEN"}
|
||||
* @visibility secret
|
||||
* */
|
||||
token?: string;
|
||||
}>;
|
||||
};
|
||||
/**
|
||||
* LdapOrg processor configuration
|
||||
*/
|
||||
ldapOrg?: {
|
||||
/**
|
||||
* attr: 'providers' - accepts an array of objects with below attributes
|
||||
*/
|
||||
providers: {
|
||||
/**
|
||||
* attr: 'target' - accepts url string e.g. ldaps://ds.example.net
|
||||
*/
|
||||
target: string;
|
||||
/**
|
||||
* The settings to use for the a command
|
||||
* opt-attr: 'bind' - accepts key value pair object
|
||||
* e.g. {"dn": "uid=ldap-reader-user","secret": {"$secret": {"env": "LDAP_SECRET"}}}
|
||||
*/
|
||||
bind?: {
|
||||
/**
|
||||
* attr: 'dn' - accepts string with ldap related parameters
|
||||
* e.g. "dn": "uid=ldap-reader-user,ou=people,ou=example,dc=example,dc=net"
|
||||
*/
|
||||
dn: string;
|
||||
/**
|
||||
* secret used to authenticate.
|
||||
* e.g. {"$secret": {"env": "LDAP_SECRET"}
|
||||
* @visibility secret
|
||||
* */
|
||||
secret: Object;
|
||||
};
|
||||
/**
|
||||
* The settings that govern the reading and interpretation of users.
|
||||
* attr: 'users' - accepts key value pair object
|
||||
*/
|
||||
users: {
|
||||
/**
|
||||
* attr: 'dn' - accepts string with user governing parameters
|
||||
* e.g. "dn": "ou=people,ou=example,dc=example,dc=net"
|
||||
*/
|
||||
|
||||
dn: string;
|
||||
/**
|
||||
* attr: 'options' - accepts an object of key value pair
|
||||
* keys: 'scope', 'filter', 'attributes', 'sizeLimit', 'timeLimit', 'derefAliases', 'typesOnly', 'paged'
|
||||
*/
|
||||
options: { [key: string]: string | boolean | number };
|
||||
/**
|
||||
* opt-attr: 'set - accepts an object of key value pair
|
||||
* keys: 'path', 'value'
|
||||
*/
|
||||
set?: { [key: string]: string | JsonValue };
|
||||
/**
|
||||
* attr: 'map' - accepts an object og key value pair
|
||||
* keys: 'rdn', 'name', 'description', 'displayName', 'email', 'picture', 'memberOf'
|
||||
*/
|
||||
map: { [key: string]: string };
|
||||
};
|
||||
/**
|
||||
* The settings that govern the reading and interpretation of groups.
|
||||
* attr: 'groups' - accepts key value pair object
|
||||
*/
|
||||
groups: {
|
||||
/**
|
||||
* attr: 'dn' - accepts string with user governing parameters
|
||||
* e.g. "dn": "ou=people,ou=example,dc=example,dc=net"
|
||||
*/
|
||||
|
||||
dn: string;
|
||||
/**
|
||||
* attr: 'options' - accepts an object of key value pair
|
||||
* keys: 'scope', 'filter', 'attributes', 'sizeLimit', 'timeLimit', 'derefAliases', 'typesOnly', 'paged'
|
||||
*/
|
||||
options: { [key: string]: string | boolean | number };
|
||||
/**
|
||||
* opt-attr: 'set - accepts an object of key value pair
|
||||
* keys: 'path', 'value'
|
||||
*/
|
||||
set?: { [key: string]: string | JsonValue };
|
||||
/**
|
||||
* attr: 'map' - accepts an object og key value pair
|
||||
* keys: 'rdn', 'name', 'description', 'displayName', 'email', 'picture', 'memberOf'
|
||||
*/
|
||||
map: { [key: string]: string };
|
||||
};
|
||||
};
|
||||
};
|
||||
/**
|
||||
* microsoftGraphOrg processor configuration
|
||||
*/
|
||||
microsoftGraphOrg?: {
|
||||
/**
|
||||
* attr: 'providers' - accepts object with below attributes
|
||||
*/
|
||||
providers: {
|
||||
/**
|
||||
* attr: 'target' - accepts string
|
||||
* e.g. https://graph.microsoft.com/v1.0
|
||||
*/
|
||||
|
||||
target: string;
|
||||
/**
|
||||
* attr: 'authority' - accepts string
|
||||
* e.g. https://login.microsoftonline.com
|
||||
*/
|
||||
|
||||
authority: string;
|
||||
/**
|
||||
* attr: 'tenantId' - accepts string
|
||||
* e.g. {"$env": "MICROSOFT_GRAPH_TENANT_ID"}
|
||||
* @visibility secret
|
||||
*/
|
||||
|
||||
tenantId: string;
|
||||
/**
|
||||
* attr: 'clientId' - accepts string
|
||||
* e.g. {"$env": "MICROSOFT_GRAPH_CLIENT_ID"}
|
||||
* @visibility secret
|
||||
*/
|
||||
|
||||
clientId: string;
|
||||
/**
|
||||
* attr: 'clientSecret' - accepts string
|
||||
* e.g. {"$env": "MICROSOFT_GRAPH_CLIENT_SECRET_TOKEN"}
|
||||
* @visibility secret
|
||||
*/
|
||||
|
||||
clientSecret: string;
|
||||
/**
|
||||
* opt-attr: 'userFilter' - accepts string
|
||||
* e.g. accountEnabled eq true and userType eq 'member'
|
||||
*/
|
||||
|
||||
userFilter?: string;
|
||||
/**
|
||||
* opt-attr: 'groupFilter' - accepts string
|
||||
* e.g. securityEnabled eq false and mailEnabled eq true
|
||||
*/
|
||||
|
||||
groupFilter?: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
/**
|
||||
* Location specific rules used in catalog entities - accepts array of objects with below attributes
|
||||
* A set of static locations that the catalog shall always keep itself
|
||||
* up-to-date with. This is commonly used for large, permanent integrations
|
||||
* that are defined by the Backstage operators at an organization, rather
|
||||
* than individual things that users register dynamically.
|
||||
*
|
||||
* These have (optional) rules of their own. These override what the global
|
||||
* rules above specify. This way, you can prevent everybody from register
|
||||
* e.g. User and Group entities, except for one or a few static locations
|
||||
* that have those two kinds explicitly allowed.
|
||||
*
|
||||
* For example:
|
||||
*
|
||||
* ```yaml
|
||||
* rules:
|
||||
* - allow: [Component, API, Template, Location]
|
||||
* locations:
|
||||
* - type: url
|
||||
* target: https://github.com/org/repo/blob/master/users.yaml
|
||||
* rules:
|
||||
* - allow: [User, Group]
|
||||
* - type: url
|
||||
* target: https://github.com/org/repo/blob/master/systems.yaml
|
||||
* rules:
|
||||
* - allow: [System]
|
||||
* ```
|
||||
*/
|
||||
locations?: Array<{
|
||||
/**
|
||||
* attr: 'type' - accepts string
|
||||
* e.g. url
|
||||
* The type of location, e.g. "url".
|
||||
*/
|
||||
type: string;
|
||||
/**
|
||||
* attr: 'target' - accepts string
|
||||
* e.g. https://github.com/org/repo/blob/master/users.yaml
|
||||
* The target URL of the location, e.g.
|
||||
* "https://github.com/org/repo/blob/master/users.yaml".
|
||||
*/
|
||||
target: string;
|
||||
/**
|
||||
* opt-attr: 'rules' - accepts an array of objects with below attributes
|
||||
* Optional extra rules that apply to this particular location.
|
||||
*
|
||||
* These override the global rules above.
|
||||
*/
|
||||
rules?: Array<{
|
||||
/**
|
||||
* attr: 'allow' - accepts an array of string.
|
||||
* e.g. [Component, API, Group, User, Template, Location]
|
||||
* Allow entities of these particular kinds.
|
||||
*
|
||||
* E.g. ["Group", "User"]
|
||||
*/
|
||||
allow: Array<string>;
|
||||
/**
|
||||
* opt-attr: 'locations' - accepts an array of key, value pair objects.
|
||||
* keys: 'target', 'type'
|
||||
* e.g.[{type: url, target: https://github.com}]
|
||||
*/
|
||||
locations?: Array<{ [key: string]: string }>;
|
||||
}>;
|
||||
}>;
|
||||
|
||||
/**
|
||||
* List of processor-specific options and attributes
|
||||
*/
|
||||
processors?: {
|
||||
/**
|
||||
* GithubOrgReaderProcessor configuration
|
||||
*/
|
||||
githubOrg?: {
|
||||
/**
|
||||
* The configuration parameters for each single GitHub org provider.
|
||||
*/
|
||||
providers: Array<{
|
||||
/**
|
||||
* The prefix of the target that this matches on, e.g.
|
||||
* "https://github.com", with no trailing slash.
|
||||
*/
|
||||
target: string;
|
||||
/**
|
||||
* The base URL of the API of this provider, e.g.
|
||||
* "https://api.github.com", with no trailing slash.
|
||||
*
|
||||
* May be omitted specifically for GitHub; then it will be deduced.
|
||||
*/
|
||||
apiBaseUrl?: string;
|
||||
/**
|
||||
* The authorization token to use for requests to this provider.
|
||||
*
|
||||
* If no token is specified, anonymous access is used.
|
||||
*
|
||||
* @visibility secret
|
||||
*/
|
||||
token?: string;
|
||||
}>;
|
||||
};
|
||||
|
||||
/**
|
||||
* LdapOrgReaderProcessor configuration
|
||||
*/
|
||||
ldapOrg?: {
|
||||
/**
|
||||
* The configuration parameters for each single LDAP provider.
|
||||
*/
|
||||
providers: Array<{
|
||||
/**
|
||||
* The prefix of the target that this matches on, e.g.
|
||||
* "ldaps://ds.example.net", with no trailing slash.
|
||||
*/
|
||||
target: string;
|
||||
|
||||
/**
|
||||
* The settings to use for the bind command. If none are specified,
|
||||
* the bind command is not issued.
|
||||
*/
|
||||
bind?: {
|
||||
/**
|
||||
* The DN of the user to auth as.
|
||||
*
|
||||
* E.g. "uid=ldap-robot,ou=robots,ou=example,dc=example,dc=net"
|
||||
*/
|
||||
dn: string;
|
||||
/**
|
||||
* The secret of the user to auth as (its password).
|
||||
*
|
||||
* @visibility secret
|
||||
*/
|
||||
secret: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* The settings that govern the reading and interpretation of users.
|
||||
*/
|
||||
users: {
|
||||
/**
|
||||
* The DN under which users are stored.
|
||||
*
|
||||
* E.g. "ou=people,ou=example,dc=example,dc=net"
|
||||
*/
|
||||
dn: string;
|
||||
/**
|
||||
* The search options to use. The default is scope "one" and
|
||||
* attributes "*" and "+".
|
||||
*
|
||||
* It is common to want to specify a filter, to narrow down the set
|
||||
* of matching items.
|
||||
*/
|
||||
options: {
|
||||
scope?: 'base' | 'one' | 'sub';
|
||||
filter?: string;
|
||||
attributes?: string | string[];
|
||||
paged?:
|
||||
| boolean
|
||||
| {
|
||||
pageSize?: number;
|
||||
pagePause?: boolean;
|
||||
};
|
||||
};
|
||||
/**
|
||||
* JSON paths (on a.b.c form) and hard coded values to set on those
|
||||
* paths.
|
||||
*
|
||||
* This can be useful for example if you want to hard code a
|
||||
* namespace or similar on the generated entities.
|
||||
*/
|
||||
set?: { [key: string]: JsonValue };
|
||||
/**
|
||||
* Mappings from well known entity fields, to LDAP attribute names
|
||||
*/
|
||||
map?: {
|
||||
/**
|
||||
* The name of the attribute that holds the relative
|
||||
* distinguished name of each entry. Defaults to "uid".
|
||||
*/
|
||||
rdn?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the value of
|
||||
* the metadata.name field of the entity. Defaults to "uid".
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the value of
|
||||
* the metadata.description field of the entity.
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the value of
|
||||
* the spec.profile.displayName field of the entity. Defaults to
|
||||
* "cn".
|
||||
*/
|
||||
displayName?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the value of
|
||||
* the spec.profile.email field of the entity. Defaults to
|
||||
* "mail".
|
||||
*/
|
||||
email?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the value of
|
||||
* the spec.profile.picture field of the entity.
|
||||
*/
|
||||
picture?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the values of
|
||||
* the spec.memberOf field of the entity. Defaults to "memberOf".
|
||||
*/
|
||||
memberOf?: string;
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* The settings that govern the reading and interpretation of groups.
|
||||
*/
|
||||
groups: {
|
||||
/**
|
||||
* The DN under which groups are stored.
|
||||
*
|
||||
* E.g. "ou=people,ou=example,dc=example,dc=net"
|
||||
*/
|
||||
dn: string;
|
||||
/**
|
||||
* The search options to use. The default is scope "one" and
|
||||
* attributes "*" and "+".
|
||||
*
|
||||
* It is common to want to specify a filter, to narrow down the set
|
||||
* of matching items.
|
||||
*/
|
||||
options: {
|
||||
scope?: 'base' | 'one' | 'sub';
|
||||
filter?: string;
|
||||
attributes?: string | string[];
|
||||
paged?:
|
||||
| boolean
|
||||
| {
|
||||
pageSize?: number;
|
||||
pagePause?: boolean;
|
||||
};
|
||||
};
|
||||
/**
|
||||
* JSON paths (on a.b.c form) and hard coded values to set on those
|
||||
* paths.
|
||||
*
|
||||
* This can be useful for example if you want to hard code a
|
||||
* namespace or similar on the generated entities.
|
||||
*/
|
||||
set?: { [key: string]: JsonValue };
|
||||
/**
|
||||
* Mappings from well known entity fields, to LDAP attribute names
|
||||
*/
|
||||
map?: {
|
||||
/**
|
||||
* The name of the attribute that holds the relative
|
||||
* distinguished name of each entry. Defaults to "cn".
|
||||
*/
|
||||
rdn?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the value of
|
||||
* the metadata.name field of the entity. Defaults to "cn".
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the value of
|
||||
* the metadata.description field of the entity. Defaults to
|
||||
* "description".
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the value of
|
||||
* the spec.type field of the entity. Defaults to "groupType".
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the value of
|
||||
* the spec.profile.displayName field of the entity. Defaults to
|
||||
* "cn".
|
||||
*/
|
||||
displayName?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the value of
|
||||
* the spec.profile.email field of the entity.
|
||||
*/
|
||||
email?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the value of
|
||||
* the spec.profile.picture field of the entity.
|
||||
*/
|
||||
picture?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the values of
|
||||
* the spec.parent field of the entity. Defaults to "memberOf".
|
||||
*/
|
||||
memberOf?: string;
|
||||
/**
|
||||
* The name of the attribute that shall be used for the values of
|
||||
* the spec.children field of the entity. Defaults to "member".
|
||||
*/
|
||||
members?: string;
|
||||
};
|
||||
};
|
||||
}>;
|
||||
};
|
||||
|
||||
/**
|
||||
* MicrosoftGraphOrgReaderProcessor configuration
|
||||
*/
|
||||
microsoftGraphOrg?: {
|
||||
/**
|
||||
* The configuration parameters for each single Microsoft Graph provider.
|
||||
*/
|
||||
providers: Array<{
|
||||
/**
|
||||
* The prefix of the target that this matches on, e.g.
|
||||
* "https://graph.microsoft.com/v1.0", with no trailing slash.
|
||||
*/
|
||||
target: string;
|
||||
/**
|
||||
* The auth authority used.
|
||||
*
|
||||
* Default value "https://login.microsoftonline.com"
|
||||
*/
|
||||
authority?: string;
|
||||
/**
|
||||
* The tenant whose org data we are interested in.
|
||||
*/
|
||||
tenantId: string;
|
||||
/**
|
||||
* The OAuth client ID to use for authenticating requests.
|
||||
*/
|
||||
clientId: string;
|
||||
/**
|
||||
* The OAuth client secret to use for authenticating requests.
|
||||
*
|
||||
* @visibility secret
|
||||
*/
|
||||
clientSecret: string;
|
||||
/**
|
||||
* The filter to apply to extract users.
|
||||
*
|
||||
* E.g. "accountEnabled eq true and userType eq 'member'"
|
||||
*/
|
||||
userFilter?: string;
|
||||
/**
|
||||
* The filter to apply to extract groups.
|
||||
*
|
||||
* E.g. "securityEnabled eq false and mailEnabled eq true"
|
||||
*/
|
||||
groupFilter?: string;
|
||||
}>;
|
||||
};
|
||||
};
|
||||
};
|
||||
}
|
||||
|
||||
@@ -16,13 +16,46 @@
|
||||
|
||||
import { Config } from '@backstage/config';
|
||||
|
||||
/**
|
||||
* The configuration parameters for a single Microsoft Graph provider.
|
||||
*/
|
||||
export type MicrosoftGraphProviderConfig = {
|
||||
/**
|
||||
* The prefix of the target that this matches on, e.g.
|
||||
* "https://graph.microsoft.com/v1.0", with no trailing slash.
|
||||
*/
|
||||
target: string;
|
||||
authority: string;
|
||||
/**
|
||||
* The auth authority used.
|
||||
*
|
||||
* E.g. "https://login.microsoftonline.com"
|
||||
*/
|
||||
authority?: string;
|
||||
/**
|
||||
* The tenant whose org data we are interested in.
|
||||
*/
|
||||
tenantId: string;
|
||||
/**
|
||||
* The OAuth client ID to use for authenticating requests.
|
||||
*/
|
||||
clientId: string;
|
||||
/**
|
||||
* The OAuth client secret to use for authenticating requests.
|
||||
*
|
||||
* @visibility secret
|
||||
*/
|
||||
clientSecret: string;
|
||||
/**
|
||||
* The filter to apply to extract users.
|
||||
*
|
||||
* E.g. "accountEnabled eq true and userType eq 'member'"
|
||||
*/
|
||||
userFilter?: string;
|
||||
/**
|
||||
* The filter to apply to extract groups.
|
||||
*
|
||||
* E.g. "securityEnabled eq false and mailEnabled eq true"
|
||||
*/
|
||||
groupFilter?: string;
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user