@backstage/plugin-catalog-backend-module-ldap 0.5.35-next.0 → 0.6.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @backstage/plugin-catalog-backend-module-ldap
 
+## 0.6.0-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.6.19-next.2
+  - @backstage/backend-tasks@0.5.24-next.2
+  - @backstage/plugin-catalog-node@1.12.1-next.1
+  - @backstage/catalog-model@1.5.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-catalog-common@1.0.23
+
+## 0.6.0-next.1
+
+### Minor Changes
+
+- debcc8c: Migrate LDAP catalog module to the new backend system.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-tasks@0.5.24-next.1
+  - @backstage/backend-plugin-api@0.6.19-next.1
+  - @backstage/plugin-catalog-node@1.12.1-next.0
+
 ## 0.5.35-next.0
 
 ### Patch Changes

package/README.md

@@ -8,3 +8,7 @@ groups from your Active Directory or another LDAP compatible server.
 
 See [Backstage documentation](https://backstage.io/docs/integrations/ldap/org) for details on how to install
 and configure the plugin.
+
+## Legacy backend
+
+You can find the legacy documentation at `docs/integrations/ldap/org--old.md`.

package/config.d.ts

@@ -19,6 +19,8 @@ import { JsonValue } from '@backstage/types';
 export interface Config {
   /**
    * LdapOrgEntityProvider / LdapOrgReaderProcessor configuration
+   *
+   * @deprecated This exists for backwards compatibility only and will be removed in the future.
    */
   ldap?: {
     /**
@@ -240,12 +242,237 @@ export interface Config {
 
   /**
    * Configuration options for the catalog plugin.
-   *
-   * TODO(freben): Deprecate this entire block
    */
   catalog?: {
+    /**
+     * List of provider-specific options and attributes
+     */
+    providers?: {
+      /**
+       * LdapOrg provider key
+       */
+      ldapOrg: {
+        /**
+         * Id of the LdapOrg provider
+         */
+        [id: string]: {
+          /**
+           * 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;
+          };
+
+          /**
+           * TLS settings
+           */
+          tls?: {
+            // Node TLS rejectUnauthorized
+            rejectUnauthorized?: boolean;
+          };
+
+          /**
+           * 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[];
+              sizeLimit?: number;
+              timeLimit?: number;
+              derefAliases?: number;
+              typesOnly?: boolean;
+              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[];
+              sizeLimit?: number;
+              timeLimit?: number;
+              derefAliases?: number;
+              typesOnly?: boolean;
+              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;
+            };
+          };
+        };
+      };
+    };
     /**
      * List of processor-specific options and attributes
+     *
+     * @deprecated This exists for backwards compatibility only and will be removed in the future.
      */
     processors?: {
       /**