update docs to use root

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2025-10-30 08:54:29 -04:00
parent 769e2b7880
commit e743d11fad
2 changed files with 44 additions and 44 deletions
@@ -1,44 +0,0 @@
---
-id: instance-metadata
-title: Instance Metadata Service
-sidebar_label: Instance Metadata
-description: Documentation for the Instance Metadata service
---
-
-The instance metadata service provides information about the running Backstage backend instance. Currently, it provides a list of all installed backend plugins.
-
-:::note Note
-
-The instance metadata service only provides information about the specific Backstage instance you're running on. In more complex deployments with multiple Backstage instances, this service will not provide a complete list of all plugins across all instances.
-
-:::
-
-## Using the service
-
-The following example shows how to use the instance metadata service in your `example` backend plugin to access the list of installed backend plugins.
-
-```ts
-import {
-  coreServices,
-  createBackendPlugin,
-} from '@backstage/backend-plugin-api';
-
-createBackendPlugin({
-  pluginId: 'example',
-  register(env) {
-    env.registerInit({
-      deps: {
-        instanceMetadata: coreServices.instanceMetadata,
-      },
-      async init({ instanceMetadata }) {
-        const plugins = instanceMetadata.getInstalledPlugins();
-        console.log('Installed plugins:', plugins);
-      },
-    });
-  },
-});
-```
-
-## Dynamic plugin registration
-
-The instance metadata service picks up plugins that are registered at start time through a `backend.start()` call. You need to restart the running backend instance to pick up newly installed plugins.
@@ -0,0 +1,44 @@
+---
+id: root-instance-metadata
+title: Root Instance Metadata Service
+sidebar_label: Root Instance Metadata
+description: Documentation for the Root Instance Metadata service
+---
+
+The root instance metadata service provides information about the running Backstage backend instance. Currently, it provides a list of all installed backend plugins.
+
+:::note Note
+
+The root instance metadata service only provides information about the specific Backstage instance you're running on. In more complex deployments with multiple Backstage instances, this service will not provide a complete list of all plugins across all instances.
+
+:::
+
+## Using the service
+
+The following example shows how to use the root instance metadata service in your `example` backend plugin to access the list of installed backend plugins.
+
+```ts
+import {
+  coreServices,
+  createBackendPlugin,
+} from '@backstage/backend-plugin-api';
+
+createBackendPlugin({
+  pluginId: 'example',
+  register(env) {
+    env.registerInit({
+      deps: {
+        instanceMetadata: coreServices.rootInstanceMetadata,
+      },
+      async init({ instanceMetadata }) {
+        const plugins = instanceMetadata.getInstalledPlugins();
+        console.log('Installed plugins:', plugins);
+      },
+    });
+  },
+});
+```
+
+## Dynamic plugin registration
+
+The root instance metadata service picks up plugins that are registered at start time through a `backend.start()` call. You need to restart the running backend instance to pick up newly installed plugins.