More
diff --git a/microsite/sidebars.json b/microsite/sidebars.json
index 8fa4935a38..e9993b2e8b 100644
--- a/microsite/sidebars.json
+++ b/microsite/sidebars.json
@@ -3,7 +3,6 @@
"Overview": [
"overview/what-is-backstage",
"overview/architecture-overview",
- "overview/architecture-terminology",
"overview/roadmap",
"overview/vision",
"overview/background",
diff --git a/mkdocs.yml b/mkdocs.yml
index ba607f8a6e..f85044822e 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -5,7 +5,6 @@ nav:
- Overview:
- What is Backstage?: 'overview/what-is-backstage.md'
- Backstage architecture: 'overview/architecture-overview.md'
- - Architecture and terminology: 'overview/architecture-terminology.md'
- Roadmap: 'overview/roadmap.md'
- Vision: 'overview/vision.md'
- The Spotify story: 'overview/background.md'
diff --git a/packages/app/src/App.test.tsx b/packages/app/src/App.test.tsx
index cddd093855..40c49416bf 100644
--- a/packages/app/src/App.test.tsx
+++ b/packages/app/src/App.test.tsx
@@ -31,7 +31,7 @@ describe('App', () => {
baseUrl: 'http://localhost:3003',
},
techdocs: {
- storageUrl: 'http://localhost:7000/techdocs/static/docs',
+ storageUrl: 'http://localhost:7000/api/techdocs/static/docs',
},
},
context: 'test',
diff --git a/packages/app/src/apis.ts b/packages/app/src/apis.ts
index 7f57f6f970..581a591152 100644
--- a/packages/app/src/apis.ts
+++ b/packages/app/src/apis.ts
@@ -16,11 +16,8 @@
import {
errorApiRef,
- discoveryApiRef,
- UrlPatternDiscovery,
githubAuthApiRef,
createApiFactory,
- configApiRef,
} from '@backstage/core';
import {
@@ -38,15 +35,6 @@ import {
} from '@roadiehq/backstage-plugin-github-pull-requests';
export const apis = [
- // TODO(Rugvip): migrate to use /api
- createApiFactory({
- api: discoveryApiRef,
- deps: { configApi: configApiRef },
- factory: ({ configApi }) =>
- UrlPatternDiscovery.compile(
- `${configApi.getString('backend.baseUrl')}/{{ pluginId }}`,
- ),
- }),
createApiFactory({
api: graphQlBrowseApiRef,
deps: { errorApi: errorApiRef, githubAuthApi: githubAuthApiRef },
diff --git a/packages/backend/package.json b/packages/backend/package.json
index e1b8665b57..5bfaf2ee46 100644
--- a/packages/backend/package.json
+++ b/packages/backend/package.json
@@ -37,6 +37,7 @@
"dockerode": "^3.2.0",
"example-app": "^0.1.1-alpha.23",
"express": "^4.17.1",
+ "express-promise-router": "^3.0.3",
"knex": "^0.21.1",
"pg": "^8.3.0",
"pg-connection-string": "^2.3.0",
diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts
index 7c52175d76..9d4a738ecf 100644
--- a/packages/backend/src/index.ts
+++ b/packages/backend/src/index.ts
@@ -22,12 +22,14 @@
* Happy hacking!
*/
+import Router from 'express-promise-router';
import {
createDatabaseClient,
createServiceBuilder,
loadBackendConfig,
getRootLogger,
useHotMemoize,
+ notFoundHandler,
} from '@backstage/backend-common';
import { ConfigReader, AppConfig } from '@backstage/config';
import healthcheck from './plugins/healthcheck';
@@ -78,19 +80,23 @@ async function main() {
const graphqlEnv = useHotMemoize(module, () => createEnv('graphql'));
const appEnv = useHotMemoize(module, () => createEnv('app'));
+ const apiRouter = Router();
+ apiRouter.use('/catalog', await catalog(catalogEnv));
+ apiRouter.use('/rollbar', await rollbar(rollbarEnv));
+ apiRouter.use('/scaffolder', await scaffolder(scaffolderEnv));
+ apiRouter.use('/sentry', await sentry(sentryEnv));
+ apiRouter.use('/auth', await auth(authEnv, '/api/auth'));
+ apiRouter.use('/identity', await identity(identityEnv));
+ apiRouter.use('/techdocs', await techdocs(techdocsEnv));
+ apiRouter.use('/kubernetes', await kubernetes(kubernetesEnv));
+ apiRouter.use('/proxy', await proxy(proxyEnv, '/api/proxy'));
+ apiRouter.use('/graphql', await graphql(graphqlEnv));
+ apiRouter.use(notFoundHandler());
+
const service = createServiceBuilder(module)
.loadConfig(configReader)
.addRouter('', await healthcheck(healthcheckEnv))
- .addRouter('/catalog', await catalog(catalogEnv))
- .addRouter('/rollbar', await rollbar(rollbarEnv))
- .addRouter('/scaffolder', await scaffolder(scaffolderEnv))
- .addRouter('/sentry', await sentry(sentryEnv))
- .addRouter('/auth', await auth(authEnv))
- .addRouter('/identity', await identity(identityEnv))
- .addRouter('/techdocs', await techdocs(techdocsEnv))
- .addRouter('/kubernetes', await kubernetes(kubernetesEnv))
- .addRouter('/proxy', await proxy(proxyEnv, '/proxy'))
- .addRouter('/graphql', await graphql(graphqlEnv))
+ .addRouter('/api', apiRouter)
.addRouter('', await app(appEnv));
await service.start().catch(err => {
diff --git a/packages/backend/src/plugins/auth.ts b/packages/backend/src/plugins/auth.ts
index b24dd6ca6b..60baaff6b7 100644
--- a/packages/backend/src/plugins/auth.ts
+++ b/packages/backend/src/plugins/auth.ts
@@ -17,10 +17,9 @@
import { createRouter } from '@backstage/plugin-auth-backend';
import { PluginEnvironment } from '../types';
-export default async function createPlugin({
- logger,
- database,
- config,
-}: PluginEnvironment) {
- return await createRouter({ logger, config, database });
+export default async function createPlugin(
+ { logger, database, config }: PluginEnvironment,
+ basePath: string,
+) {
+ return await createRouter({ logger, config, database, basePath });
}
diff --git a/packages/backend/src/plugins/kubernetes.ts b/packages/backend/src/plugins/kubernetes.ts
index 42b7722ff6..7906765533 100644
--- a/packages/backend/src/plugins/kubernetes.ts
+++ b/packages/backend/src/plugins/kubernetes.ts
@@ -17,6 +17,9 @@
import { createRouter } from '@backstage/plugin-kubernetes-backend';
import { PluginEnvironment } from '../types';
-export default async function createPlugin({ logger }: PluginEnvironment) {
- return await createRouter({ logger });
+export default async function createPlugin({
+ logger,
+ config,
+}: PluginEnvironment) {
+ return await createRouter({ logger, config });
}
diff --git a/packages/cli/src/commands/create-plugin/createPlugin.ts b/packages/cli/src/commands/create-plugin/createPlugin.ts
index 247812b6fd..cbaf956bdb 100644
--- a/packages/cli/src/commands/create-plugin/createPlugin.ts
+++ b/packages/cli/src/commands/create-plugin/createPlugin.ts
@@ -231,7 +231,11 @@ export default async (cmd: Command) => {
const privatePackage = cmd.private === false ? false : true;
const isMonoRepo = await fs.pathExists(paths.resolveTargetRoot('lerna.json'));
const appPackage = paths.resolveTargetRoot('packages/app');
- const templateDir = paths.resolveOwn('templates/default-plugin');
+ const templateDir = paths.resolveOwn(
+ cmd.backend
+ ? 'templates/default-backend-plugin'
+ : 'templates/default-plugin',
+ );
const tempDir = resolvePath(os.tmpdir(), answers.id);
const pluginDir = isMonoRepo
? paths.resolveTargetRoot('plugins', answers.id)
@@ -252,6 +256,7 @@ export default async (cmd: Command) => {
await createTemporaryPluginFolder(tempDir);
Task.section('Preparing files');
+
await templatingTask(templateDir, tempDir, {
...answers,
version,
@@ -267,7 +272,7 @@ export default async (cmd: Command) => {
Task.section('Building the plugin');
await buildPlugin(pluginDir);
- if (await fs.pathExists(appPackage)) {
+ if ((await fs.pathExists(appPackage)) && !cmd.backend) {
Task.section('Adding plugin as dependency in app');
await addPluginDependencyToApp(paths.targetRoot, name, version);
diff --git a/packages/cli/src/commands/index.ts b/packages/cli/src/commands/index.ts
index f1828cef84..fea250cd55 100644
--- a/packages/cli/src/commands/index.ts
+++ b/packages/cli/src/commands/index.ts
@@ -61,6 +61,10 @@ export function registerCommands(program: CommanderStatic) {
program
.command('create-plugin')
+ .option(
+ '--backend',
+ 'Create plugin with the backend dependencies as default',
+ )
.description('Creates a new plugin in the current repository')
.option('--scope
', 'NPM scope')
.option('--npm-registry ', 'NPM registry URL')
diff --git a/packages/cli/templates/default-backend-plugin/.eslintrc.js b/packages/cli/templates/default-backend-plugin/.eslintrc.js
new file mode 100644
index 0000000000..16a033dbc6
--- /dev/null
+++ b/packages/cli/templates/default-backend-plugin/.eslintrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+ extends: [require.resolve('@backstage/cli/config/eslint.backend')],
+};
diff --git a/packages/cli/templates/default-backend-plugin/README.md.hbs b/packages/cli/templates/default-backend-plugin/README.md.hbs
new file mode 100644
index 0000000000..5c34b40360
--- /dev/null
+++ b/packages/cli/templates/default-backend-plugin/README.md.hbs
@@ -0,0 +1,14 @@
+# {{id}}
+
+Welcome to the {{id}} backend plugin!
+
+_This plugin was created through the Backstage CLI_
+
+## Getting started
+
+Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn
+start` in the root directory, and then navigating to [/{{id}}](http://localhost:3000/{{id}}).
+
+You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
+This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
+It is only meant for local development, and the setup for it can be found inside the [/dev](/dev) directory.
diff --git a/packages/cli/templates/default-backend-plugin/package.json.hbs b/packages/cli/templates/default-backend-plugin/package.json.hbs
new file mode 100644
index 0000000000..40e612609a
--- /dev/null
+++ b/packages/cli/templates/default-backend-plugin/package.json.hbs
@@ -0,0 +1,44 @@
+{
+ "name": "{{name}}",
+ "version": "{{version}}",
+ "main": "src/index.ts",
+ "types": "src/index.ts",
+ "license": "Apache-2.0",
+ {{#if privatePackage}} "private": {{privatePackage}},
+ {{/if}}
+ "publishConfig": {
+ {{#if npmRegistry}} "registry": "{{npmRegistry}}",
+ {{/if}}
+ "access": "public",
+ "main": "dist/index.cjs.js",
+ "types": "dist/index.d.ts"
+ },
+ "scripts": {
+ "start": "backstage-cli backend:dev",
+ "build": "backstage-cli backend:build",
+ "lint": "backstage-cli lint",
+ "test": "backstage-cli test",
+ "prepack": "backstage-cli prepack",
+ "postpack": "backstage-cli postpack",
+ "clean": "backstage-cli clean"
+ },
+ "dependencies": {
+ "@backstage/backend-common": "^{{version}}",
+ "@backstage/config": "^{{version}}",
+ "@types/express": "^4.17.6",
+ "express": "^4.17.1",
+ "express-promise-router": "^3.0.3",
+ "winston": "^3.2.1",
+ "node-fetch": "^2.6.1",
+ "yn": "^4.0.0"
+ },
+ "devDependencies": {
+ "@backstage/cli": "^{{version}}",
+ "@types/supertest": "^2.0.8",
+ "supertest": "^4.0.2",
+ "msw": "^0.20.5"
+ },
+ "files": [
+ "dist"
+ ]
+ }
diff --git a/packages/cli/templates/default-backend-plugin/src/index.ts b/packages/cli/templates/default-backend-plugin/src/index.ts
new file mode 100644
index 0000000000..7612c392a2
--- /dev/null
+++ b/packages/cli/templates/default-backend-plugin/src/index.ts
@@ -0,0 +1,17 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './service/router';
diff --git a/packages/cli/templates/default-backend-plugin/src/run.ts.hbs b/packages/cli/templates/default-backend-plugin/src/run.ts.hbs
new file mode 100644
index 0000000000..b96989e4b8
--- /dev/null
+++ b/packages/cli/templates/default-backend-plugin/src/run.ts.hbs
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { getRootLogger } from '@backstage/backend-common';
+import yn from 'yn';
+import { startStandaloneServer } from './service/standaloneServer';
+
+const port = process.env.PLUGIN_PORT ? Number(process.env.PLUGIN_PORT) : 7000;
+const enableCors = yn(process.env.PLUGIN_CORS, { default: false });
+const logger = getRootLogger();
+
+startStandaloneServer({ port, enableCors, logger }).catch(err => {
+ logger.error(err);
+ process.exit(1);
+});
+
+process.on('SIGINT', () => {
+ logger.info('CTRL+C pressed; exiting.');
+ process.exit(0);
+});
diff --git a/packages/cli/templates/default-backend-plugin/src/service/router.test.ts b/packages/cli/templates/default-backend-plugin/src/service/router.test.ts
new file mode 100644
index 0000000000..0aaeafa379
--- /dev/null
+++ b/packages/cli/templates/default-backend-plugin/src/service/router.test.ts
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { getVoidLogger } from '@backstage/backend-common';
+import express from 'express';
+import request from 'supertest';
+
+import { createRouter } from './router';
+
+describe('createRouter', () => {
+ let app: express.Express;
+
+ beforeAll(async () => {
+ const router = await createRouter({
+ logger: getVoidLogger(),
+ });
+ app = express().use(router);
+ });
+
+ beforeEach(() => {
+ jest.resetAllMocks();
+ });
+
+ describe('GET /health', () => {
+ it('returns ok', async () => {
+ const response = await request(app).get('/health');
+
+ expect(response.status).toEqual(200);
+ expect(response.body).toEqual({ status: 'ok' });
+ });
+ });
+});
diff --git a/packages/cli/templates/default-backend-plugin/src/service/router.ts b/packages/cli/templates/default-backend-plugin/src/service/router.ts
new file mode 100644
index 0000000000..3ea8219365
--- /dev/null
+++ b/packages/cli/templates/default-backend-plugin/src/service/router.ts
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { errorHandler } from '@backstage/backend-common';
+import express from 'express';
+import Router from 'express-promise-router';
+import { Logger } from 'winston';
+
+export interface RouterOptions {
+ logger: Logger;
+}
+
+export async function createRouter(
+ options: RouterOptions,
+): Promise {
+ const { logger } = options;
+
+ const router = Router();
+ router.use(express.json());
+
+ router.get('/health', (_, response) => {
+ logger.info('PONG!');
+ response.send({ status: 'ok' });
+ });
+ router.use(errorHandler());
+ return router;
+}
diff --git a/packages/cli/templates/default-backend-plugin/src/service/standaloneServer.ts.hbs b/packages/cli/templates/default-backend-plugin/src/service/standaloneServer.ts.hbs
new file mode 100644
index 0000000000..6e38965246
--- /dev/null
+++ b/packages/cli/templates/default-backend-plugin/src/service/standaloneServer.ts.hbs
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { createServiceBuilder } from '@backstage/backend-common';
+import { Server } from 'http';
+import { Logger } from 'winston';
+import { createRouter } from './router';
+
+export interface ServerOptions {
+ port: number;
+ enableCors: boolean;
+ logger: Logger;
+}
+
+export async function startStandaloneServer(
+ options: ServerOptions,
+): Promise {
+ const logger = options.logger.child({ service: '{{id}}-backend' });
+ logger.debug('Starting application server...');
+ const router = await createRouter({
+ logger,
+ });
+
+ const service = createServiceBuilder(module)
+ .enableCors({ origin: 'http://localhost:3000' })
+ .addRouter('/{{id}}', router);
+
+ return await service.start().catch(err => {
+ logger.error(err);
+ process.exit(1);
+ });
+}
+
+module.hot?.accept();
diff --git a/packages/cli/templates/default-backend-plugin/src/setupTests.ts b/packages/cli/templates/default-backend-plugin/src/setupTests.ts
new file mode 100644
index 0000000000..a5907fd52f
--- /dev/null
+++ b/packages/cli/templates/default-backend-plugin/src/setupTests.ts
@@ -0,0 +1,18 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export {};
+global.fetch = require('node-fetch');
diff --git a/packages/cli/templates/default-plugin/package.json.hbs b/packages/cli/templates/default-plugin/package.json.hbs
index 52cffeb621..e024884547 100644
--- a/packages/cli/templates/default-plugin/package.json.hbs
+++ b/packages/cli/templates/default-plugin/package.json.hbs
@@ -41,7 +41,8 @@
"@testing-library/user-event": "^12.0.7",
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0",
- "jest-fetch-mock": "^3.0.3"
+ "msw": "^0.20.5",
+ "node-fetch": "^2.6.1"
},
"files": [
"dist"
diff --git a/packages/cli/templates/default-plugin/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs b/packages/cli/templates/default-plugin/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs
index 37759313ee..1069790218 100644
--- a/packages/cli/templates/default-plugin/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs
+++ b/packages/cli/templates/default-plugin/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs
@@ -1,18 +1,35 @@
import React from 'react';
import { render } from '@testing-library/react';
-import mockFetch from 'jest-fetch-mock';
import ExampleComponent from './ExampleComponent';
import { ThemeProvider } from '@material-ui/core';
import { lightTheme } from '@backstage/theme';
+import { rest } from 'msw';
+import { setupServer } from 'msw/node';
+
describe('ExampleComponent', () => {
+ const server = setupServer();
+ // Enable API mocking before tests.
+ beforeAll(() => server.listen())
+
+ // Reset any runtime request handlers we may add during the tests.
+ afterEach(() => server.resetHandlers())
+
+ // Disable API mocking after the tests are done.
+ afterAll(() => server.close())
+
+ // setup mock response
+ beforeEach(() => {
+ server.use(rest.get('/*', (_, res, ctx) => res(ctx.status(200), ctx.json({}))))
+ })
+
it('should render', () => {
- mockFetch.mockResponse(() => new Promise(() => {}));
const rendered = render(
,
- );
- expect(rendered.getByText('Welcome to {{ id }}!')).toBeInTheDocument();
+ );
+ expect(rendered.getByText('Welcome to {{ id }}!')).toBeInTheDocument();
});
});
+
\ No newline at end of file
diff --git a/packages/cli/templates/default-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.test.tsx.hbs b/packages/cli/templates/default-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.test.tsx.hbs
index cc61c215cd..c584289077 100644
--- a/packages/cli/templates/default-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.test.tsx.hbs
+++ b/packages/cli/templates/default-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.test.tsx.hbs
@@ -1,11 +1,25 @@
import React from 'react';
import { render } from '@testing-library/react';
-import mockFetch from 'jest-fetch-mock';
import ExampleFetchComponent from './ExampleFetchComponent';
+import { rest } from 'msw';
+import { setupServer } from 'msw/node';
describe('ExampleFetchComponent', () => {
+ const server = setupServer();
+ // Enable API mocking before tests.
+ beforeAll(() => server.listen())
+
+ // Reset any runtime request handlers we may add during the tests.
+ afterEach(() => server.resetHandlers())
+
+ // Disable API mocking after the tests are done.
+ afterAll(() => server.close())
+
+ // setup mock response
+ beforeEach(() => {
+ server.use(rest.get('https://randomuser.me/*', (_, res, ctx) => res(ctx.status(200), ctx.delay(2000), ctx.json({}))))
+ })
it('should render', async () => {
- mockFetch.mockResponse(() => new Promise(() => {}));
const rendered = render();
expect(await rendered.findByTestId('progress')).toBeInTheDocument();
});
diff --git a/packages/cli/templates/default-plugin/src/setupTests.ts b/packages/cli/templates/default-plugin/src/setupTests.ts
index 3fa8703ac4..cc559f672e 100644
--- a/packages/cli/templates/default-plugin/src/setupTests.ts
+++ b/packages/cli/templates/default-plugin/src/setupTests.ts
@@ -1,3 +1,2 @@
import '@testing-library/jest-dom';
-
-require('jest-fetch-mock').enableMocks();
+global.fetch = require('node-fetch');
diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/packages/create-app/templates/default-app/app-config.yaml.hbs
index a7d7aa8010..92c517bf93 100644
--- a/packages/create-app/templates/default-app/app-config.yaml.hbs
+++ b/packages/create-app/templates/default-app/app-config.yaml.hbs
@@ -44,8 +44,8 @@ proxy:
changeOrigin: true
techdocs:
- storageUrl: http://localhost:7000/techdocs/static/docs
- requestUrl: http://localhost:7000/techdocs/docs
+ storageUrl: http://localhost:7000/api/techdocs/static/docs
+ requestUrl: http://localhost:7000/api/techdocs/docs
generators:
techdocs: 'docker'
diff --git a/packages/create-app/templates/default-app/packages/app/src/App.test.tsx b/packages/create-app/templates/default-app/packages/app/src/App.test.tsx
index e88c3b47dd..21a2eaa703 100644
--- a/packages/create-app/templates/default-app/packages/app/src/App.test.tsx
+++ b/packages/create-app/templates/default-app/packages/app/src/App.test.tsx
@@ -12,7 +12,7 @@ describe('App', () => {
app: { title: 'Test' },
backend: { baseUrl: 'http://localhost:7000' },
techdocs: {
- storageUrl: 'http://localhost:7000/techdocs/static/docs',
+ storageUrl: 'http://localhost:7000/api/techdocs/static/docs',
},
},
context: 'test',
diff --git a/packages/create-app/templates/default-app/packages/backend/package.json.hbs b/packages/create-app/templates/default-app/packages/backend/package.json.hbs
index adde81e830..b70f36650e 100644
--- a/packages/create-app/templates/default-app/packages/backend/package.json.hbs
+++ b/packages/create-app/templates/default-app/packages/backend/package.json.hbs
@@ -31,6 +31,7 @@
"@gitbeaker/node": "^23.5.0",
"dockerode": "^3.2.0",
"express": "^4.17.1",
+ "express-promise-router": "^3.0.3",
"knex": "^0.21.1",
{{#if dbTypePG}}
"pg": "^8.3.0",
diff --git a/packages/create-app/templates/default-app/packages/backend/src/index.ts b/packages/create-app/templates/default-app/packages/backend/src/index.ts
index 6a014727e9..457b95a7a9 100644
--- a/packages/create-app/templates/default-app/packages/backend/src/index.ts
+++ b/packages/create-app/templates/default-app/packages/backend/src/index.ts
@@ -6,12 +6,14 @@
* Happy hacking!
*/
+import Router from 'express-promise-router';
import {
createDatabaseClient,
createServiceBuilder,
loadBackendConfig,
getRootLogger,
useHotMemoize,
+ notFoundHandler,
} from '@backstage/backend-common';
import { ConfigReader, AppConfig } from '@backstage/config';
import auth from './plugins/auth';
@@ -51,14 +53,18 @@ async function main() {
const proxyEnv = useHotMemoize(module, () => createEnv('proxy'));
const techdocsEnv = useHotMemoize(module, () => createEnv('techdocs'));
+ const apiRouter = Router();
+ apiRouter.use('/catalog', await catalog(catalogEnv))
+ apiRouter.use('/scaffolder', await scaffolder(scaffolderEnv))
+ apiRouter.use('/auth', await auth(authEnv))
+ apiRouter.use('/identity', await identity(identityEnv))
+ apiRouter.use('/techdocs', await techdocs(techdocsEnv))
+ apiRouter.use('/proxy', await proxy(proxyEnv, '/api/proxy'))
+ apiRouter.use(notFoundHandler());
+
const service = createServiceBuilder(module)
.loadConfig(configReader)
- .addRouter('/catalog', await catalog(catalogEnv))
- .addRouter('/scaffolder', await scaffolder(scaffolderEnv))
- .addRouter('/auth', await auth(authEnv))
- .addRouter('/identity', await identity(identityEnv))
- .addRouter('/techdocs', await techdocs(techdocsEnv))
- .addRouter('/proxy', await proxy(proxyEnv, '/proxy'));
+ .addRouter('/api', apiRouter)
await service.start().catch(err => {
console.log(err);
diff --git a/packages/e2e-test/src/e2e-test.ts b/packages/e2e-test/src/e2e-test.ts
index 969a77cb2a..c7f6137ff1 100644
--- a/packages/e2e-test/src/e2e-test.ts
+++ b/packages/e2e-test/src/e2e-test.ts
@@ -55,6 +55,9 @@ async function main() {
print('Creating a Backstage Plugin');
const pluginName = await createPlugin('test-plugin', appDir);
+ print('Creating a Backstage Backend Plugin');
+ await createPlugin('test-backend-plugin', appDir, ['--backend']);
+
print('Starting the app');
await testAppServe(pluginName, appDir);
@@ -238,8 +241,12 @@ async function overrideModuleResolutions(appDir: string, workspaceDir: string) {
/**
* Uses create-plugin command to create a new plugin in the app
*/
-async function createPlugin(pluginName: string, appDir: string) {
- const child = spawnPiped(['yarn', 'create-plugin'], {
+async function createPlugin(
+ pluginName: string,
+ appDir: string,
+ options: string[] = [],
+) {
+ const child = spawnPiped(['yarn', 'create-plugin', ...options], {
cwd: appDir,
});
@@ -384,7 +391,7 @@ async function testBackendStart(appDir: string, isPostgres: boolean) {
print('Try to fetch entities from the backend');
// Try fetch entities, should be ok
- await fetch('http://localhost:7000/catalog/entities').then(res =>
+ await fetch('http://localhost:7000/api/catalog/entities').then(res =>
res.json(),
);
print('Entities fetched successfully');
diff --git a/packages/techdocs-container/techdocs-core/README.md b/packages/techdocs-container/techdocs-core/README.md
index 49b9fce4e4..7f34722e81 100644
--- a/packages/techdocs-container/techdocs-core/README.md
+++ b/packages/techdocs-container/techdocs-core/README.md
@@ -82,6 +82,10 @@ Extensions:
## Changelog
+### 0.0.9
+
+- Change development status to 3 - Alpha
+
### 0.0.8
- Superfences and Codehilite doesn't work very well together (squidfunk/mkdocs-material#1604) so therefore the codehilite extension is replaced by pymdownx.highlight
diff --git a/packages/techdocs-container/techdocs-core/setup.py b/packages/techdocs-container/techdocs-core/setup.py
index e5a8206150..4385bc2e38 100644
--- a/packages/techdocs-container/techdocs-core/setup.py
+++ b/packages/techdocs-container/techdocs-core/setup.py
@@ -14,13 +14,19 @@ See the License for the specific language governing permissions and
limitations under the License.
"""
from setuptools import setup, find_packages
+from os import path
+# read the contents of the README file in the current directory
+this_dir = path.abspath(path.dirname(__file__))
+with open(path.join(this_dir, "README.md"), encoding="utf-8") as file:
+ long_description = file.read()
setup(
name="mkdocs-techdocs-core",
- version="0.0.8",
+ version="0.0.9",
description="A Mkdocs package that contains TechDocs defaults",
- long_description="",
+ long_description=long_description,
+ long_description_content_type="text/markdown",
keywords="mkdocs",
url="https://github.com/spotify/backstage",
author="TechDocs Core",
@@ -37,7 +43,7 @@ setup(
"pymdown-extensions==7.1",
],
classifiers=[
- "Development Status :: 1 - Planning",
+ "Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Intended Audience :: Information Technology",
"License :: OSI Approved :: Apache Software License",
diff --git a/packages/theme/src/themes.ts b/packages/theme/src/themes.ts
index 73d6c13859..72a1df716f 100644
--- a/packages/theme/src/themes.ts
+++ b/packages/theme/src/themes.ts
@@ -80,12 +80,12 @@ export const darkTheme = createTheme({
default: '#333333',
},
status: {
- ok: '#1DB954',
- warning: '#FF9800',
- error: '#E22134',
- running: '#2E77D0',
- pending: '#FFED51',
- aborted: '#757575',
+ ok: '#71CF88',
+ warning: '#FFB84D',
+ error: '#F84C55',
+ running: '#3488E3',
+ pending: '#FEF071',
+ aborted: '#9E9E9E',
},
bursts: {
fontColor: '#FEFEFE',
@@ -103,7 +103,7 @@ export const darkTheme = createTheme({
},
border: '#E6E6E6',
textContrast: '#FFFFFF',
- textVerySubtle: '#DDD',
+ textVerySubtle: '#ececec',
textSubtle: '#EEEEEE',
highlight: '#FFFBCC',
errorBackground: '#FFEBEE',
diff --git a/plugins/api-docs/package.json b/plugins/api-docs/package.json
index bc384bf796..b9e37d6d7a 100644
--- a/plugins/api-docs/package.json
+++ b/plugins/api-docs/package.json
@@ -49,7 +49,9 @@
"@types/node": "^12.0.0",
"@types/react": "^16.9",
"@types/swagger-ui-react": "^3.23.3",
- "jest-fetch-mock": "^3.0.3"
+ "jest-fetch-mock": "^3.0.3",
+ "msw": "^0.20.5",
+ "node-fetch": "^2.6.1"
},
"files": [
"dist"
diff --git a/plugins/app-backend/package.json b/plugins/app-backend/package.json
index 8d7fb67171..d403580f86 100644
--- a/plugins/app-backend/package.json
+++ b/plugins/app-backend/package.json
@@ -32,7 +32,7 @@
"devDependencies": {
"@backstage/cli": "^0.1.1-alpha.23",
"@types/supertest": "^2.0.8",
- "msw": "^0.19.5",
+ "msw": "^0.20.5",
"supertest": "^4.0.2"
},
"files": [
diff --git a/plugins/auth-backend/README.md b/plugins/auth-backend/README.md
index 9af90df3f2..355fcc1536 100644
--- a/plugins/auth-backend/README.md
+++ b/plugins/auth-backend/README.md
@@ -34,8 +34,8 @@ Follow this link, [Create new OAuth App](https://github.com/settings/application
1. Set Application Name to `backstage-dev` or something along those lines.
1. You can set the Homepage URL to whatever you want to.
1. The Authorization Callback URL should match the redirect URI set in Backstage.
- 1. Set this to `http://localhost:7000/auth/github` for local development.
- 1. Set this to `http://{APP_FQDN}:{APP_BACKEND_PORT}/auth/github` for non-local deployments.
+ 1. Set this to `http://localhost:7000/api/auth/github` for local development.
+ 1. Set this to `http://{APP_FQDN}:{APP_BACKEND_PORT}/api/auth/github` for non-local deployments.
```bash
export AUTH_GITHUB_CLIENT_ID=x
@@ -78,14 +78,14 @@ export AUTH_AUTH0_CLIENT_SECRET=x
#### Creating an Azure AD App Registration
-An Azure AD App Registration is required to be able to sign in using Azure AD and the Microsoft Graph API.
+An Azure AD App Registration is required to be able to sign in using Azure AD and the Microsoft Graph API.
Click [here](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps) to create a new one.
- Click on the `New Registration` button.
- Give the app a name. e.g. `backstage-dev`
- Select `Accounts in this organizational directory only` under supported account types.
- Enter the callback URL for your backstage backend instance:
- - For local development, this is likely `http://localhost:7000/auth/microsoft/handler/frame`
+ - For local development, this is likely `http://localhost:7000/api/auth/microsoft/handler/frame`
- For non-local deployments, this will be `https://{APP_FQDN}:{APP_BACKEND_PORT}/auth/microsoft/handler/frame`
- Click `Register`.
diff --git a/plugins/auth-backend/package.json b/plugins/auth-backend/package.json
index d1c563229c..8a9bfadca1 100644
--- a/plugins/auth-backend/package.json
+++ b/plugins/auth-backend/package.json
@@ -58,7 +58,8 @@
"@types/passport-google-oauth20": "^2.0.3",
"@types/passport-microsoft": "^0.0.0",
"@types/passport-saml": "^1.1.2",
- "jest-fetch-mock": "^3.0.3"
+ "jest-fetch-mock": "^3.0.3",
+ "msw": "^0.20.5"
},
"files": [
"dist",
diff --git a/plugins/auth-backend/scripts/start-saml-idp.sh b/plugins/auth-backend/scripts/start-saml-idp.sh
index 33217f7978..b312a4b85e 100755
--- a/plugins/auth-backend/scripts/start-saml-idp.sh
+++ b/plugins/auth-backend/scripts/start-saml-idp.sh
@@ -18,4 +18,4 @@ fi
echo "Downloading and starting SAML-IdP"
export NPM_CONFIG_REGISTRY=https://registry.npmjs.org
-exec npx saml-idp --acsUrl "http://localhost:7000/auth/saml/handler/frame" --audience "http://localhost:7000" --port 7001
+exec npx saml-idp --acsUrl "http://localhost:7000/api/auth/saml/handler/frame" --audience "http://localhost:7000" --port 7001
diff --git a/plugins/auth-backend/src/service/router.ts b/plugins/auth-backend/src/service/router.ts
index 19a74d47c5..e70e687879 100644
--- a/plugins/auth-backend/src/service/router.ts
+++ b/plugins/auth-backend/src/service/router.ts
@@ -28,6 +28,7 @@ export interface RouterOptions {
logger: Logger;
database: Knex;
config: Config;
+ basePath?: string;
}
export async function createRouter(
@@ -38,7 +39,8 @@ export async function createRouter(
const appUrl = options.config.getString('app.baseUrl');
const backendUrl = options.config.getString('backend.baseUrl');
- const authUrl = `${backendUrl}/auth`;
+ // TODO(Rugvip): Replace with service discovery of external URL
+ const authUrl = backendUrl + (options.basePath ?? '/api/auth');
const keyDurationSeconds = 3600;
diff --git a/plugins/catalog-graphql/package.json b/plugins/catalog-graphql/package.json
index 5d767c4f85..8597f3aa3c 100644
--- a/plugins/catalog-graphql/package.json
+++ b/plugins/catalog-graphql/package.json
@@ -39,7 +39,7 @@
"@types/express": "^4.17.7",
"@types/supertest": "^2.0.8",
"eslint-plugin-graphql": "^4.0.0",
- "msw": "^0.19.5",
+ "msw": "^0.20.5",
"supertest": "^4.0.2",
"ts-node": "^8.10.2"
},
diff --git a/plugins/catalog/package.json b/plugins/catalog/package.json
index ea6f2ae44d..d3241ec10d 100644
--- a/plugins/catalog/package.json
+++ b/plugins/catalog/package.json
@@ -53,7 +53,8 @@
"jest-fetch-mock": "^3.0.3",
"msw": "^0.20.5",
"react-test-renderer": "^16.13.1",
- "whatwg-fetch": "^3.4.0"
+ "whatwg-fetch": "^3.4.0",
+ "node-fetch": "^2.6.1"
},
"files": [
"dist"
diff --git a/plugins/circleci/package.json b/plugins/circleci/package.json
index ebff4b9eba..a661c2562f 100644
--- a/plugins/circleci/package.json
+++ b/plugins/circleci/package.json
@@ -46,7 +46,9 @@
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0",
"@types/react-lazylog": "^4.5.0",
- "jest-fetch-mock": "^3.0.3"
+ "jest-fetch-mock": "^3.0.3",
+ "msw": "^0.20.5",
+ "node-fetch": "^2.6.1"
},
"files": [
"dist"
diff --git a/plugins/explore/package.json b/plugins/explore/package.json
index 1a498f1dc2..2f25b4f137 100644
--- a/plugins/explore/package.json
+++ b/plugins/explore/package.json
@@ -41,7 +41,9 @@
"@testing-library/user-event": "^12.0.7",
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0",
- "jest-fetch-mock": "^3.0.3"
+ "jest-fetch-mock": "^3.0.3",
+ "msw": "^0.20.5",
+ "node-fetch": "^2.6.1"
},
"files": [
"dist"
diff --git a/plugins/gcp-projects/package.json b/plugins/gcp-projects/package.json
index 603fcf5a31..406b2428df 100644
--- a/plugins/gcp-projects/package.json
+++ b/plugins/gcp-projects/package.json
@@ -4,7 +4,6 @@
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
- "private": true,
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
@@ -39,7 +38,9 @@
"@testing-library/user-event": "^12.0.7",
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0",
- "jest-fetch-mock": "^3.0.3"
+ "jest-fetch-mock": "^3.0.3",
+ "msw": "^0.20.5",
+ "node-fetch": "^2.6.1"
},
"files": [
"dist"
diff --git a/plugins/github-actions/package.json b/plugins/github-actions/package.json
index f7000407ac..5d85d8b3fa 100644
--- a/plugins/github-actions/package.json
+++ b/plugins/github-actions/package.json
@@ -47,7 +47,9 @@
"@testing-library/user-event": "^12.0.7",
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0",
- "jest-fetch-mock": "^3.0.3"
+ "jest-fetch-mock": "^3.0.3",
+ "msw": "^0.20.5",
+ "node-fetch": "^2.6.1"
},
"files": [
"dist"
diff --git a/plugins/gitops-profiles/package.json b/plugins/gitops-profiles/package.json
index 1168b05c6d..a58ba6576a 100644
--- a/plugins/gitops-profiles/package.json
+++ b/plugins/gitops-profiles/package.json
@@ -39,7 +39,9 @@
"@testing-library/user-event": "^12.0.7",
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0",
- "jest-fetch-mock": "^3.0.3"
+ "jest-fetch-mock": "^3.0.3",
+ "msw": "^0.20.5",
+ "node-fetch": "^2.6.1"
},
"files": [
"dist"
diff --git a/plugins/graphiql/package.json b/plugins/graphiql/package.json
index 3042e6cd57..1db4bba978 100644
--- a/plugins/graphiql/package.json
+++ b/plugins/graphiql/package.json
@@ -53,7 +53,9 @@
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0",
"jest-fetch-mock": "^3.0.3",
- "react-router-dom": "6.0.0-beta.0"
+ "react-router-dom": "6.0.0-beta.0",
+ "msw": "^0.20.5",
+ "node-fetch": "^2.6.1"
},
"files": [
"dist"
diff --git a/plugins/identity-backend/package.json b/plugins/identity-backend/package.json
index fb9bffc2e2..63ecb65d1e 100644
--- a/plugins/identity-backend/package.json
+++ b/plugins/identity-backend/package.json
@@ -34,7 +34,8 @@
},
"devDependencies": {
"@backstage/cli": "^0.1.1-alpha.23",
- "jest-fetch-mock": "^3.0.3"
+ "jest-fetch-mock": "^3.0.3",
+ "msw": "^0.20.5"
},
"files": [
"dist"
diff --git a/plugins/jenkins/package.json b/plugins/jenkins/package.json
index e777dd2119..84e8a47664 100644
--- a/plugins/jenkins/package.json
+++ b/plugins/jenkins/package.json
@@ -44,7 +44,9 @@
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0",
"@types/testing-library__jest-dom": "^5.9.1",
- "jest-fetch-mock": "^3.0.3"
+ "jest-fetch-mock": "^3.0.3",
+ "msw": "^0.20.5",
+ "node-fetch": "^2.6.1"
},
"files": [
"dist"
diff --git a/plugins/kubernetes-backend/examples/dice-roller/README.md b/plugins/kubernetes-backend/examples/dice-roller/README.md
new file mode 100644
index 0000000000..b64e2df37f
--- /dev/null
+++ b/plugins/kubernetes-backend/examples/dice-roller/README.md
@@ -0,0 +1,42 @@
+# Dice roller
+
+An app to roll dice (it doesn't actually do that).
+
+# Viewing in local Minikube running Backstage locally
+
+## Prerequisites
+
+- kubectl installed
+- Minikube installed
+- jq installed
+- Backstage locally built and ready to run
+
+## Steps
+
+1. Start minikube
+2. Get the Kubernetes master base url `kubectl cluster-info`
+3. Apply manifests `kubectl apply -f dice-roller-manifests.yaml`
+4. Get service account token (see below)
+5. Start Backstage UI and backend
+6. Register existing component in Backstage
+ - https://github.com/mclarke47/dice-roller/blob/master/catalog-info.yaml
+
+Update `app-config.yaml` as follows.
+
+```yaml
+---
+kubernetes:
+ clusterLocatorMethod: 'configMultiTenant'
+ clusters:
+ - url:
+ name: minikube
+ serviceAccountToken:
+```
+
+### Getting the service account token
+
+```
+kubectl get secret DICE_ROLLER_TOKEN_NAME -o=json | jq -r '.data["token"]' | base64 --decode | pbcopy
+```
+
+Paste into `app-config.yaml` `kubernetes.clusters[].serviceAccountToken`
diff --git a/plugins/kubernetes-backend/examples/dice-roller/catalog-info.yaml b/plugins/kubernetes-backend/examples/dice-roller/catalog-info.yaml
new file mode 100644
index 0000000000..a944232224
--- /dev/null
+++ b/plugins/kubernetes-backend/examples/dice-roller/catalog-info.yaml
@@ -0,0 +1,13 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+ name: dice-roller
+ description: It rolls dice
+ tags:
+ - go
+ annotations:
+ 'backstage.io/kubernetes-id': dice-roller
+spec:
+ type: service
+ lifecycle: production
+ owner: guest
diff --git a/plugins/kubernetes-backend/examples/dice-roller/dice-roller-manifests.yaml b/plugins/kubernetes-backend/examples/dice-roller/dice-roller-manifests.yaml
new file mode 100644
index 0000000000..ef448c1688
--- /dev/null
+++ b/plugins/kubernetes-backend/examples/dice-roller/dice-roller-manifests.yaml
@@ -0,0 +1,79 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: dice-roller
+ labels:
+ 'backstage.io/kubernetes-id': dice-roller
+spec:
+ selector:
+ matchLabels:
+ app: dice-roller
+ replicas: 2
+ template:
+ metadata:
+ labels:
+ app: dice-roller
+ 'backstage.io/kubernetes-id': dice-roller
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.14.2
+ ports:
+ - containerPort: 80
+
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+ name: dice-roller
+ namespace: default
+ labels:
+ 'backstage.io/kubernetes-id': dice-roller
+data:
+ foo: bar
+
+---
+apiVersion: v1
+kind: Secret
+metadata:
+ name: dice-roller
+ labels:
+ 'backstage.io/kubernetes-id': dice-roller
+type: Opaque
+data:
+ username: YWRtaW4=
+---
+apiVersion: v1
+kind: Service
+metadata:
+ name: dice-roller
+ labels:
+ 'backstage.io/kubernetes-id': dice-roller
+spec:
+ selector:
+ app: dice-roller
+ ports:
+ - protocol: TCP
+ port: 80
+ targetPort: 9376
+
+---
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+ name: dice-roller
+automountServiceAccountToken: false
+
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+ name: sa-admin
+roleRef:
+ kind: ClusterRole
+ name: cluster-admin
+ apiGroup: rbac.authorization.k8s.io
+subjects:
+ - kind: ServiceAccount
+ name: dice-roller
+ namespace: default
diff --git a/plugins/kubernetes-backend/package.json b/plugins/kubernetes-backend/package.json
index 406d9c8d7f..e1f7a39592 100644
--- a/plugins/kubernetes-backend/package.json
+++ b/plugins/kubernetes-backend/package.json
@@ -21,7 +21,9 @@
},
"dependencies": {
"@backstage/backend-common": "^0.1.1-alpha.23",
+ "@backstage/config": "^0.1.1-alpha.23",
"@types/express": "^4.17.6",
+ "@kubernetes/client-node": "^0.12.1",
"compression": "^1.7.4",
"cors": "^2.8.5",
"express": "^4.17.1",
@@ -29,12 +31,14 @@
"fs-extra": "^9.0.0",
"helmet": "^4.0.0",
"morgan": "^1.10.0",
+ "stream-buffers": "^3.0.2",
"winston": "^3.2.1",
"yn": "^4.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.1.1-alpha.23",
- "jest-fetch-mock": "^3.0.3"
+ "jest-fetch-mock": "^3.0.3",
+ "supertest": "^4.0.2",
+ "@backstage/cli": "^0.1.1-alpha.23"
},
"files": [
"dist"
diff --git a/plugins/kubernetes-backend/src/cluster-locator/MultiTenantConfigClusterLocator.test.ts b/plugins/kubernetes-backend/src/cluster-locator/MultiTenantConfigClusterLocator.test.ts
new file mode 100644
index 0000000000..34788d16cb
--- /dev/null
+++ b/plugins/kubernetes-backend/src/cluster-locator/MultiTenantConfigClusterLocator.test.ts
@@ -0,0 +1,105 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import '@backstage/backend-common';
+import { MultiTenantConfigClusterLocator } from './MultiTenantConfigClusterLocator';
+import { ConfigReader, Config } from '@backstage/config';
+
+describe('MultiTenantConfigClusterLocator', () => {
+ it('empty clusters returns empty cluster details', async () => {
+ const config: Config = new ConfigReader(
+ {
+ clusters: [],
+ },
+ 'ctx',
+ );
+
+ const sut = MultiTenantConfigClusterLocator.fromConfig(
+ config.getConfigArray('clusters'),
+ );
+
+ const result = await sut.getClusterByServiceId('ignored');
+
+ expect(result).toStrictEqual([]);
+ });
+
+ it('one clusters returns one cluster details', async () => {
+ const config: Config = new ConfigReader(
+ {
+ clusters: [
+ {
+ name: 'cluster1',
+ url: 'http://localhost:8080',
+ },
+ ],
+ },
+ 'ctx',
+ );
+
+ const sut = MultiTenantConfigClusterLocator.fromConfig(
+ config.getConfigArray('clusters'),
+ );
+
+ const result = await sut.getClusterByServiceId('ignored');
+
+ expect(result).toStrictEqual([
+ {
+ name: 'cluster1',
+ serviceAccountToken: undefined,
+ url: 'http://localhost:8080',
+ },
+ ]);
+ });
+
+ it('two clusters returns two cluster details', async () => {
+ const config: Config = new ConfigReader(
+ {
+ clusters: [
+ {
+ name: 'cluster1',
+ serviceAccountToken: undefined,
+ url: 'http://localhost:8080',
+ },
+ {
+ name: 'cluster2',
+ serviceAccountToken: undefined,
+ url: 'http://localhost:8081',
+ },
+ ],
+ },
+ 'ctx',
+ );
+
+ const sut = MultiTenantConfigClusterLocator.fromConfig(
+ config.getConfigArray('clusters'),
+ );
+
+ const result = await sut.getClusterByServiceId('ignored');
+
+ expect(result).toStrictEqual([
+ {
+ name: 'cluster1',
+ serviceAccountToken: undefined,
+ url: 'http://localhost:8080',
+ },
+ {
+ name: 'cluster2',
+ serviceAccountToken: undefined,
+ url: 'http://localhost:8081',
+ },
+ ]);
+ });
+});
diff --git a/plugins/kubernetes-backend/src/cluster-locator/MultiTenantConfigClusterLocator.ts b/plugins/kubernetes-backend/src/cluster-locator/MultiTenantConfigClusterLocator.ts
new file mode 100644
index 0000000000..3d9e2dd8b4
--- /dev/null
+++ b/plugins/kubernetes-backend/src/cluster-locator/MultiTenantConfigClusterLocator.ts
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Config } from '@backstage/config';
+import { ClusterDetails, KubernetesClusterLocator } from '..';
+
+// This cluster locator assumes that every service is located on every cluster
+// Therefore it will always return all clusters in an app configuration file
+export class MultiTenantConfigClusterLocator
+ implements KubernetesClusterLocator {
+ private readonly clusterDetails: ClusterDetails[];
+
+ constructor(clusterDetails: ClusterDetails[]) {
+ this.clusterDetails = clusterDetails;
+ }
+
+ static fromConfig(config: Config[]): MultiTenantConfigClusterLocator {
+ return new MultiTenantConfigClusterLocator(
+ config.map(c => {
+ return {
+ name: c.getString('name'),
+ url: c.getString('url'),
+ serviceAccountToken: c.getOptionalString('serviceAccountToken'),
+ };
+ }),
+ );
+ }
+
+ // As this implementation always returns all clusters serviceId is ignored here
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
+ async getClusterByServiceId(_serviceId: string): Promise {
+ return this.clusterDetails;
+ }
+}
diff --git a/plugins/kubernetes-backend/src/cluster-locator/types.ts b/plugins/kubernetes-backend/src/cluster-locator/types.ts
new file mode 100644
index 0000000000..9b793da558
--- /dev/null
+++ b/plugins/kubernetes-backend/src/cluster-locator/types.ts
@@ -0,0 +1,17 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export type ClusterLocatorMethod = 'configMultiTenant' | 'http';
diff --git a/plugins/kubernetes-backend/src/index.ts b/plugins/kubernetes-backend/src/index.ts
index 7612c392a2..96f070ff1e 100644
--- a/plugins/kubernetes-backend/src/index.ts
+++ b/plugins/kubernetes-backend/src/index.ts
@@ -15,3 +15,4 @@
*/
export * from './service/router';
+export * from './types/types';
diff --git a/plugins/kubernetes-backend/src/service/KubernetesClientProvider.test.ts b/plugins/kubernetes-backend/src/service/KubernetesClientProvider.test.ts
new file mode 100644
index 0000000000..a3dc67716a
--- /dev/null
+++ b/plugins/kubernetes-backend/src/service/KubernetesClientProvider.test.ts
@@ -0,0 +1,136 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import '@backstage/backend-common';
+import { KubernetesClientProvider } from './KubernetesClientProvider';
+
+describe('KubernetesClientProvider', () => {
+ beforeEach(() => {
+ jest.resetAllMocks();
+ });
+
+ it('can get core client by cluster details', async () => {
+ const sut = new KubernetesClientProvider();
+
+ const mockGetKubeConfig = jest.fn(sut.getKubeConfig.bind({}));
+
+ sut.getKubeConfig = mockGetKubeConfig;
+
+ const result = sut.getCoreClientByClusterDetails({
+ name: 'cluster-name',
+ url: 'http://localhost:9999',
+ serviceAccountToken: 'TOKEN',
+ });
+
+ expect(result.basePath).toBe('http://localhost:9999');
+ // These fields aren't on the type but are there
+ const auth = (result as any).authentications.default;
+ expect(auth.users[0].token).toBe('TOKEN');
+ expect(auth.clusters[0].name).toBe('cluster-name');
+
+ expect(mockGetKubeConfig.mock.calls.length).toBe(1);
+ });
+
+ it('can get cached core client by cluster details', async () => {
+ const sut = new KubernetesClientProvider();
+
+ const mockGetKubeConfig = jest.fn(sut.getKubeConfig.bind({}));
+
+ sut.getKubeConfig = mockGetKubeConfig;
+
+ const result1 = sut.getCoreClientByClusterDetails({
+ name: 'cluster-name',
+ url: 'http://localhost:9999',
+ serviceAccountToken: 'TOKEN',
+ });
+
+ const result2 = sut.getCoreClientByClusterDetails({
+ name: 'cluster-name',
+ url: 'http://localhost:9999',
+ serviceAccountToken: 'TOKEN',
+ });
+
+ expect(result1.basePath).toBe('http://localhost:9999');
+ // These fields aren't on the type but are there
+ const auth1 = (result1 as any).authentications.default;
+ expect(auth1.users[0].token).toBe('TOKEN');
+ expect(auth1.clusters[0].name).toBe('cluster-name');
+
+ expect(result2.basePath).toBe('http://localhost:9999');
+ // These fields aren't on the type but are there
+ const auth2 = (result2 as any).authentications.default;
+ expect(auth2.users[0].token).toBe('TOKEN');
+ expect(auth2.clusters[0].name).toBe('cluster-name');
+
+ expect(mockGetKubeConfig.mock.calls.length).toBe(1);
+ });
+
+ it('can get apps client by cluster details', async () => {
+ const sut = new KubernetesClientProvider();
+
+ const mockGetKubeConfig = jest.fn(sut.getKubeConfig.bind({}));
+
+ sut.getKubeConfig = mockGetKubeConfig;
+
+ const result = sut.getAppsClientByClusterDetails({
+ name: 'cluster-name',
+ url: 'http://localhost:9999',
+ serviceAccountToken: 'TOKEN',
+ });
+
+ expect(result.basePath).toBe('http://localhost:9999');
+ // These fields aren't on the type but are there
+ const auth = (result as any).authentications.default;
+ expect(auth.users[0].token).toBe('TOKEN');
+ expect(auth.clusters[0].name).toBe('cluster-name');
+
+ expect(mockGetKubeConfig.mock.calls.length).toBe(1);
+ });
+
+ it('can get cached apps client by cluster details', async () => {
+ const sut = new KubernetesClientProvider();
+
+ const mockGetKubeConfig = jest.fn(sut.getKubeConfig.bind({}));
+
+ sut.getKubeConfig = mockGetKubeConfig;
+
+ const result1 = sut.getAppsClientByClusterDetails({
+ name: 'cluster-name',
+ url: 'http://localhost:9999',
+ serviceAccountToken: 'TOKEN',
+ });
+
+ const result2 = sut.getAppsClientByClusterDetails({
+ name: 'cluster-name',
+ url: 'http://localhost:9999',
+ serviceAccountToken: 'TOKEN',
+ });
+
+ expect(result1.basePath).toBe('http://localhost:9999');
+ // These fields aren't on the type but are there
+ const auth1 = (result1 as any).authentications.default;
+ expect(auth1.users[0].token).toBe('TOKEN');
+ expect(auth1.clusters[0].name).toBe('cluster-name');
+
+ expect(result2.basePath).toBe('http://localhost:9999');
+ // These fields aren't on the type but are there
+ const auth2 = (result2 as any).authentications.default;
+ expect(auth2.users[0].token).toBe('TOKEN');
+ expect(auth2.clusters[0].name).toBe('cluster-name');
+
+ expect(mockGetKubeConfig.mock.calls.length).toBe(1);
+ });
+});
diff --git a/plugins/kubernetes-backend/src/service/KubernetesClientProvider.ts b/plugins/kubernetes-backend/src/service/KubernetesClientProvider.ts
new file mode 100644
index 0000000000..c3986e3ff7
--- /dev/null
+++ b/plugins/kubernetes-backend/src/service/KubernetesClientProvider.ts
@@ -0,0 +1,96 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ClusterDetails } from '..';
+import { AppsV1Api, CoreV1Api, KubeConfig } from '@kubernetes/client-node';
+
+export class KubernetesClientProvider {
+ private readonly coreClientMap: {
+ [key: string]: CoreV1Api;
+ };
+
+ private readonly appsClientMap: {
+ [key: string]: AppsV1Api;
+ };
+
+ constructor() {
+ this.coreClientMap = {};
+ this.appsClientMap = {};
+ }
+
+ // visible for testing
+ getKubeConfig(clusterDetails: ClusterDetails) {
+ const cluster = {
+ name: clusterDetails.name,
+ server: clusterDetails.url,
+ // TODO configure this
+ skipTLSVerify: true,
+ };
+
+ // TODO configure
+ const user = {
+ name: 'service-account',
+ token: clusterDetails.serviceAccountToken,
+ };
+
+ const context = {
+ name: `${clusterDetails.name}`,
+ user: user.name,
+ cluster: cluster.name,
+ };
+
+ const kc = new KubeConfig();
+ kc.loadFromOptions({
+ clusters: [cluster],
+ users: [user],
+ contexts: [context],
+ currentContext: context.name,
+ });
+ return kc;
+ }
+
+ getCoreClientByClusterDetails(clusterDetails: ClusterDetails) {
+ const clientMapKey = clusterDetails.name;
+
+ if (this.coreClientMap.hasOwnProperty(clientMapKey)) {
+ return this.coreClientMap[clientMapKey];
+ }
+
+ const kc = this.getKubeConfig(clusterDetails);
+
+ const client = kc.makeApiClient(CoreV1Api);
+
+ this.coreClientMap[clientMapKey] = client;
+
+ return client;
+ }
+
+ getAppsClientByClusterDetails(clusterDetails: ClusterDetails) {
+ const clientMapKey = clusterDetails.name;
+
+ if (this.appsClientMap.hasOwnProperty(clientMapKey)) {
+ return this.appsClientMap[clientMapKey];
+ }
+
+ const kc = this.getKubeConfig(clusterDetails);
+
+ const client = kc.makeApiClient(AppsV1Api);
+
+ this.appsClientMap[clientMapKey] = client;
+
+ return client;
+ }
+}
diff --git a/plugins/kubernetes-backend/src/service/KubernetesFetcher.test.ts b/plugins/kubernetes-backend/src/service/KubernetesFetcher.test.ts
new file mode 100644
index 0000000000..359e7c5806
--- /dev/null
+++ b/plugins/kubernetes-backend/src/service/KubernetesFetcher.test.ts
@@ -0,0 +1,108 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { getVoidLogger } from '@backstage/backend-common';
+import { KubernetesClientBasedFetcher } from './KubernetesFetcher';
+
+describe('KubernetesClientProvider', () => {
+ beforeEach(() => {
+ jest.resetAllMocks();
+ });
+
+ it('should return pods, services', async () => {
+ const clientMock: any = {
+ listPodForAllNamespaces: jest.fn(),
+ listServiceForAllNamespaces: jest.fn(),
+ };
+
+ const kubernetesClientProvider: any = {
+ getCoreClientByClusterDetails: jest.fn(() => clientMock),
+ getAppsClientByClusterDetails: jest.fn(() => clientMock),
+ };
+
+ const sut = new KubernetesClientBasedFetcher({
+ kubernetesClientProvider,
+ logger: getVoidLogger(),
+ });
+
+ clientMock.listPodForAllNamespaces.mockResolvedValueOnce({
+ body: {
+ items: [
+ {
+ metadata: {
+ name: 'pod-name',
+ },
+ },
+ ],
+ },
+ });
+
+ clientMock.listServiceForAllNamespaces.mockResolvedValueOnce({
+ body: {
+ items: [
+ {
+ metadata: {
+ name: 'service-name',
+ },
+ },
+ ],
+ },
+ });
+
+ const result = await sut.fetchObjectsByServiceId(
+ 'some-service',
+ {
+ name: 'cluster1',
+ url: 'http://localhost:9999',
+ serviceAccountToken: undefined,
+ },
+ new Set(['pods', 'services']),
+ );
+
+ expect(result).toStrictEqual([
+ {
+ type: 'pods',
+ resources: [
+ {
+ metadata: {
+ name: 'pod-name',
+ },
+ },
+ ],
+ },
+ {
+ type: 'services',
+ resources: [
+ {
+ metadata: {
+ name: 'service-name',
+ },
+ },
+ ],
+ },
+ ]);
+
+ expect(clientMock.listPodForAllNamespaces.mock.calls.length).toBe(1);
+ expect(clientMock.listServiceForAllNamespaces.mock.calls.length).toBe(1);
+
+ expect(
+ kubernetesClientProvider.getAppsClientByClusterDetails.mock.calls.length,
+ ).toBe(2);
+ expect(
+ kubernetesClientProvider.getCoreClientByClusterDetails.mock.calls.length,
+ ).toBe(2);
+ });
+});
diff --git a/plugins/kubernetes-backend/src/service/KubernetesFetcher.ts b/plugins/kubernetes-backend/src/service/KubernetesFetcher.ts
new file mode 100644
index 0000000000..f6d3edb5e9
--- /dev/null
+++ b/plugins/kubernetes-backend/src/service/KubernetesFetcher.ts
@@ -0,0 +1,212 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+ AppsV1Api,
+ CoreV1Api,
+ V1ConfigMap,
+ V1Deployment,
+ V1Pod,
+ V1ReplicaSet,
+ V1Secret,
+} from '@kubernetes/client-node';
+import { KubernetesClientProvider } from './KubernetesClientProvider';
+import { V1Service } from '@kubernetes/client-node/dist/gen/model/v1Service';
+import { Logger } from 'winston';
+import {
+ KubernetesFetcher,
+ ClusterDetails,
+ KubernetesObjectTypes,
+ FetchResponse,
+} from '..';
+
+export interface Clients {
+ core: CoreV1Api;
+ apps: AppsV1Api;
+}
+
+export interface KubernetesClientBasedFetcherOptions {
+ kubernetesClientProvider: KubernetesClientProvider;
+ logger: Logger;
+}
+
+export class KubernetesClientBasedFetcher implements KubernetesFetcher {
+ private readonly kubernetesClientProvider: KubernetesClientProvider;
+ private readonly logger: Logger;
+
+ constructor({
+ kubernetesClientProvider,
+ logger,
+ }: KubernetesClientBasedFetcherOptions) {
+ this.kubernetesClientProvider = kubernetesClientProvider;
+ this.logger = logger;
+ }
+
+ fetchObjectsByServiceId(
+ serviceId: string,
+ clusterDetails: ClusterDetails,
+ objectTypesToFetch: Set,
+ ): Promise {
+ return Promise.all(
+ Array.from(objectTypesToFetch).map(type => {
+ return this.fetchByObjectType(serviceId, clusterDetails, type);
+ }),
+ );
+ }
+
+ private fetchByObjectType(
+ serviceId: string,
+ clusterDetails: ClusterDetails,
+ type: KubernetesObjectTypes,
+ ): Promise {
+ switch (type) {
+ case 'pods':
+ return this.fetchPodsByServiceId(serviceId, clusterDetails).then(r => ({
+ type: type,
+ resources: r,
+ }));
+ case 'configmaps':
+ return this.fetchConfigMapsByServiceId(
+ serviceId,
+ clusterDetails,
+ ).then(r => ({ type: type, resources: r }));
+ case 'deployments':
+ return this.fetchDeploymentsByServiceId(
+ serviceId,
+ clusterDetails,
+ ).then(r => ({ type: type, resources: r }));
+ case 'replicasets':
+ return this.fetchReplicaSetsByServiceId(
+ serviceId,
+ clusterDetails,
+ ).then(r => ({ type: type, resources: r }));
+ case 'secrets':
+ return this.fetchSecretsByServiceId(
+ serviceId,
+ clusterDetails,
+ ).then(r => ({ type: type, resources: r }));
+ case 'services':
+ return this.fetchServicesByServiceId(
+ serviceId,
+ clusterDetails,
+ ).then(r => ({ type: type, resources: r }));
+ default:
+ // unrecognised type
+ throw new Error(`unrecognised type=${type}`);
+ }
+ }
+
+ private singleClusterFetch(
+ clusterDetails: ClusterDetails,
+ fn: (client: Clients) => Promise<{ body: { items: Array } }>,
+ ): Promise> {
+ const core = this.kubernetesClientProvider.getCoreClientByClusterDetails(
+ clusterDetails,
+ );
+ const apps = this.kubernetesClientProvider.getAppsClientByClusterDetails(
+ clusterDetails,
+ );
+
+ this.logger.debug(`calling cluster=${clusterDetails.name}`);
+ return fn({ core, apps }).then(result => {
+ return result.body.items;
+ });
+ }
+
+ private fetchServicesByServiceId(
+ serviceId: string,
+ clusterDetails: ClusterDetails,
+ ): Promise> {
+ return this.singleClusterFetch(clusterDetails, ({ core }) =>
+ core.listServiceForAllNamespaces(
+ false,
+ '',
+ '',
+ `backstage.io/kubernetes-id=${serviceId}`,
+ ),
+ );
+ }
+
+ private fetchPodsByServiceId(
+ serviceId: string,
+ clusterDetails: ClusterDetails,
+ ): Promise> {
+ return this.singleClusterFetch(clusterDetails, ({ core }) =>
+ core.listPodForAllNamespaces(
+ false,
+ '',
+ '',
+ `backstage.io/kubernetes-id=${serviceId}`,
+ ),
+ );
+ }
+
+ private fetchConfigMapsByServiceId(
+ serviceId: string,
+ clusterDetails: ClusterDetails,
+ ): Promise> {
+ return this.singleClusterFetch(clusterDetails, ({ core }) =>
+ core.listConfigMapForAllNamespaces(
+ false,
+ '',
+ '',
+ `backstage.io/kubernetes-id=${serviceId}`,
+ ),
+ );
+ }
+
+ private fetchSecretsByServiceId(
+ serviceId: string,
+ clusterDetails: ClusterDetails,
+ ): Promise> {
+ return this.singleClusterFetch(clusterDetails, ({ core }) =>
+ core.listSecretForAllNamespaces(
+ false,
+ '',
+ '',
+ `backstage.io/kubernetes-id=${serviceId}`,
+ ),
+ );
+ }
+
+ private fetchDeploymentsByServiceId(
+ serviceId: string,
+ clusterDetails: ClusterDetails,
+ ): Promise> {
+ return this.singleClusterFetch(clusterDetails, ({ apps }) =>
+ apps.listDeploymentForAllNamespaces(
+ false,
+ '',
+ '',
+ `backstage.io/kubernetes-id=${serviceId}`,
+ ),
+ );
+ }
+
+ private fetchReplicaSetsByServiceId(
+ serviceId: string,
+ clusterDetails: ClusterDetails,
+ ): Promise> {
+ return this.singleClusterFetch(clusterDetails, ({ apps }) =>
+ apps.listReplicaSetForAllNamespaces(
+ false,
+ '',
+ '',
+ `backstage.io/kubernetes-id=${serviceId}`,
+ ),
+ );
+ }
+}
diff --git a/plugins/kubernetes-backend/src/service/getKubernetesObjectsByServiceIdHandler.test.ts b/plugins/kubernetes-backend/src/service/getKubernetesObjectsByServiceIdHandler.test.ts
new file mode 100644
index 0000000000..3f8081571a
--- /dev/null
+++ b/plugins/kubernetes-backend/src/service/getKubernetesObjectsByServiceIdHandler.test.ts
@@ -0,0 +1,242 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { handleGetKubernetesObjectsByServiceId } from './getKubernetesObjectsByServiceIdHandler';
+import { getVoidLogger } from '@backstage/backend-common';
+import { ClusterDetails } from '..';
+
+const TEST_SERVICE_ID = 'my-service';
+
+const fetchObjectsByServiceId = jest.fn();
+
+const getClusterByServiceId = jest.fn();
+
+const mockFetch = (mock: jest.Mock) => {
+ mock.mockImplementation((serviceId: string, clusterDetails: ClusterDetails) =>
+ Promise.resolve([
+ {
+ type: 'pods',
+ resources: [
+ {
+ metadata: {
+ name: `my-pods-${serviceId}-${clusterDetails.name}`,
+ },
+ },
+ ],
+ },
+ {
+ type: 'configmaps',
+ resources: [
+ {
+ metadata: {
+ name: `my-configmaps-${serviceId}-${clusterDetails.name}`,
+ },
+ },
+ ],
+ },
+ {
+ type: 'services',
+ resources: [
+ {
+ metadata: {
+ name: `my-services-${serviceId}-${clusterDetails.name}`,
+ },
+ },
+ ],
+ },
+ ]),
+ );
+};
+
+describe('handleGetKubernetesObjectsByServiceId', () => {
+ beforeEach(() => {
+ jest.resetAllMocks();
+ });
+
+ it('retrieve objects for one cluster', async () => {
+ getClusterByServiceId.mockImplementation(() =>
+ Promise.resolve([
+ {
+ name: 'test-cluster',
+ },
+ ]),
+ );
+
+ mockFetch(fetchObjectsByServiceId);
+
+ const result = await handleGetKubernetesObjectsByServiceId(
+ TEST_SERVICE_ID,
+ {
+ fetchObjectsByServiceId,
+ },
+ {
+ getClusterByServiceId,
+ },
+ getVoidLogger(),
+ );
+
+ expect(getClusterByServiceId.mock.calls.length).toBe(1);
+ expect(fetchObjectsByServiceId.mock.calls.length).toBe(1);
+ expect(result).toStrictEqual({
+ items: [
+ {
+ cluster: {
+ name: 'test-cluster',
+ },
+ resources: [
+ {
+ resources: [
+ {
+ metadata: {
+ name: 'my-pods-my-service-test-cluster',
+ },
+ },
+ ],
+ type: 'pods',
+ },
+ {
+ resources: [
+ {
+ metadata: {
+ name: 'my-configmaps-my-service-test-cluster',
+ },
+ },
+ ],
+ type: 'configmaps',
+ },
+ {
+ resources: [
+ {
+ metadata: {
+ name: 'my-services-my-service-test-cluster',
+ },
+ },
+ ],
+ type: 'services',
+ },
+ ],
+ },
+ ],
+ });
+ });
+
+ it('retrieve objects for two clusters', async () => {
+ getClusterByServiceId.mockImplementation(() =>
+ Promise.resolve([
+ {
+ name: 'test-cluster',
+ },
+ {
+ name: 'other-cluster',
+ },
+ ]),
+ );
+
+ mockFetch(fetchObjectsByServiceId);
+
+ const result = await handleGetKubernetesObjectsByServiceId(
+ TEST_SERVICE_ID,
+ {
+ fetchObjectsByServiceId,
+ },
+ {
+ getClusterByServiceId,
+ },
+ getVoidLogger(),
+ );
+
+ expect(getClusterByServiceId.mock.calls.length).toBe(1);
+ expect(fetchObjectsByServiceId.mock.calls.length).toBe(2);
+ expect(result).toStrictEqual({
+ items: [
+ {
+ cluster: {
+ name: 'test-cluster',
+ },
+ resources: [
+ {
+ resources: [
+ {
+ metadata: {
+ name: 'my-pods-my-service-test-cluster',
+ },
+ },
+ ],
+ type: 'pods',
+ },
+ {
+ resources: [
+ {
+ metadata: {
+ name: 'my-configmaps-my-service-test-cluster',
+ },
+ },
+ ],
+ type: 'configmaps',
+ },
+ {
+ resources: [
+ {
+ metadata: {
+ name: 'my-services-my-service-test-cluster',
+ },
+ },
+ ],
+ type: 'services',
+ },
+ ],
+ },
+ {
+ cluster: {
+ name: 'other-cluster',
+ },
+ resources: [
+ {
+ resources: [
+ {
+ metadata: {
+ name: 'my-pods-my-service-other-cluster',
+ },
+ },
+ ],
+ type: 'pods',
+ },
+ {
+ resources: [
+ {
+ metadata: {
+ name: 'my-configmaps-my-service-other-cluster',
+ },
+ },
+ ],
+ type: 'configmaps',
+ },
+ {
+ resources: [
+ {
+ metadata: {
+ name: 'my-services-my-service-other-cluster',
+ },
+ },
+ ],
+ type: 'services',
+ },
+ ],
+ },
+ ],
+ });
+ });
+});
diff --git a/plugins/kubernetes-backend/src/service/getKubernetesObjectsByServiceIdHandler.ts b/plugins/kubernetes-backend/src/service/getKubernetesObjectsByServiceIdHandler.ts
new file mode 100644
index 0000000000..52968d4c20
--- /dev/null
+++ b/plugins/kubernetes-backend/src/service/getKubernetesObjectsByServiceIdHandler.ts
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Logger } from 'winston';
+import {
+ KubernetesClusterLocator,
+ KubernetesFetcher,
+ KubernetesObjectTypes,
+ ObjectsByServiceIdResponse,
+} from '..';
+
+export type GetKubernetesObjectsByServiceIdHandler = (
+ serviceId: string,
+ fetcher: KubernetesFetcher,
+ clusterLocator: KubernetesClusterLocator,
+ logger: Logger,
+ objectsToFetch?: Set,
+) => Promise;
+
+const DEFAULT_OBJECTS = new Set([
+ 'pods',
+ 'services',
+ 'configmaps',
+ 'secrets',
+ 'deployments',
+ 'replicasets',
+]);
+
+export const handleGetKubernetesObjectsByServiceId: GetKubernetesObjectsByServiceIdHandler = async (
+ serviceId,
+ fetcher,
+ clusterLocator,
+ logger,
+ objectsToFetch = DEFAULT_OBJECTS,
+) => {
+ const clusterDetails = await clusterLocator.getClusterByServiceId(serviceId);
+
+ logger.info(
+ `serviceId=${serviceId} clusterDetails=${clusterDetails.map(c => c.name)}`,
+ );
+
+ return Promise.all(
+ clusterDetails.map(cd => {
+ return fetcher
+ .fetchObjectsByServiceId(serviceId, cd, objectsToFetch)
+ .then(result => {
+ return {
+ cluster: {
+ name: cd.name,
+ },
+ resources: result,
+ };
+ });
+ }),
+ ).then(r => ({ items: r }));
+};
diff --git a/plugins/kubernetes-backend/src/service/router.test.ts b/plugins/kubernetes-backend/src/service/router.test.ts
new file mode 100644
index 0000000000..7731fe9abb
--- /dev/null
+++ b/plugins/kubernetes-backend/src/service/router.test.ts
@@ -0,0 +1,87 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { getVoidLogger } from '@backstage/backend-common';
+import express from 'express';
+import request from 'supertest';
+import { makeRouter } from './router';
+import {
+ KubernetesClusterLocator,
+ KubernetesFetcher,
+ ObjectsByServiceIdResponse,
+} from '..';
+
+describe('router', () => {
+ let app: express.Express;
+ let kubernetesFetcher: jest.Mocked;
+ let kubernetesClusterLocator: jest.Mocked;
+ let handleGetByServiceId: jest.Mock>;
+
+ beforeAll(async () => {
+ kubernetesFetcher = {
+ fetchObjectsByServiceId: jest.fn(),
+ };
+
+ kubernetesClusterLocator = {
+ getClusterByServiceId: jest.fn(),
+ };
+
+ handleGetByServiceId = jest.fn();
+
+ const router = makeRouter(
+ getVoidLogger(),
+ kubernetesFetcher,
+ kubernetesClusterLocator,
+ handleGetByServiceId as any,
+ );
+ app = express().use(router);
+ });
+
+ beforeEach(() => {
+ jest.resetAllMocks();
+ });
+
+ describe('GET /services/:serviceId', () => {
+ it('happy path: lists kubernetes objects', async () => {
+ const result = {
+ clusterOne: {
+ pods: [
+ {
+ metadata: {
+ name: 'pod1',
+ },
+ },
+ ],
+ },
+ } as any;
+ handleGetByServiceId.mockReturnValueOnce(Promise.resolve(result));
+
+ const response = await request(app).get('/services/test-service');
+
+ expect(response.status).toEqual(200);
+ expect(response.body).toEqual(result);
+ });
+
+ it('internal error: lists kubernetes objects', async () => {
+ handleGetByServiceId.mockRejectedValue(Error('some internal error'));
+
+ const response = await request(app).get('/services/test-service');
+
+ expect(response.status).toEqual(500);
+ expect(response.body).toEqual({ error: 'some internal error' });
+ });
+ });
+});
diff --git a/plugins/kubernetes-backend/src/service/router.ts b/plugins/kubernetes-backend/src/service/router.ts
index b200896887..d038c1ed7d 100644
--- a/plugins/kubernetes-backend/src/service/router.ts
+++ b/plugins/kubernetes-backend/src/service/router.ts
@@ -17,19 +17,65 @@
import express from 'express';
import Router from 'express-promise-router';
import { Logger } from 'winston';
+import { Config } from '@backstage/config';
+import { ClusterLocatorMethod } from '../cluster-locator/types';
+import { MultiTenantConfigClusterLocator } from '../cluster-locator/MultiTenantConfigClusterLocator';
+import { KubernetesClientBasedFetcher } from './KubernetesFetcher';
+import { KubernetesClientProvider } from './KubernetesClientProvider';
+import {
+ GetKubernetesObjectsByServiceIdHandler,
+ handleGetKubernetesObjectsByServiceId,
+} from './getKubernetesObjectsByServiceIdHandler';
+import { KubernetesClusterLocator, KubernetesFetcher } from '..';
export interface RouterOptions {
logger: Logger;
+ config: Config;
}
-const makeRouter = (logger: Logger): express.Router => {
+const getClusterLocator = (config: Config): KubernetesClusterLocator => {
+ const clusterLocatorMethod = config.getString(
+ 'kubernetes.clusterLocatorMethod',
+ ) as ClusterLocatorMethod;
+
+ switch (clusterLocatorMethod) {
+ case 'configMultiTenant':
+ return MultiTenantConfigClusterLocator.fromConfig(
+ config.getConfigArray('kubernetes.clusters'),
+ );
+ case 'http':
+ throw new Error('not implemented');
+ default:
+ throw new Error(
+ `Unsupported kubernetes.clusterLocatorMethod "${clusterLocatorMethod}"`,
+ );
+ }
+};
+
+export const makeRouter = (
+ logger: Logger,
+ fetcher: KubernetesFetcher,
+ clusterLocator: KubernetesClusterLocator,
+ handleGetByServiceId: GetKubernetesObjectsByServiceIdHandler,
+): express.Router => {
const router = Router();
router.use(express.json());
+ // TODO error handling
router.get('/services/:serviceId', async (req, res) => {
const serviceId = req.params.serviceId;
- logger.info(`HERE ${serviceId}`);
- res.send({ serviceId });
+
+ try {
+ const response = await handleGetByServiceId(
+ serviceId,
+ fetcher,
+ clusterLocator,
+ logger,
+ );
+ res.send(response);
+ } catch (e) {
+ res.status(500).send({ error: e.message });
+ }
});
return router;
@@ -41,5 +87,18 @@ export async function createRouter(
const logger = options.logger;
logger.info('Initializing Kubernetes backend');
- return makeRouter(logger);
+
+ const clusterLocator = getClusterLocator(options.config);
+
+ const fetcher = new KubernetesClientBasedFetcher({
+ kubernetesClientProvider: new KubernetesClientProvider(),
+ logger,
+ });
+
+ return makeRouter(
+ logger,
+ fetcher,
+ clusterLocator,
+ handleGetKubernetesObjectsByServiceId,
+ );
}
diff --git a/plugins/kubernetes-backend/src/service/standaloneApplication.ts b/plugins/kubernetes-backend/src/service/standaloneApplication.ts
index 5eea4fb8f5..e23e87a7a2 100644
--- a/plugins/kubernetes-backend/src/service/standaloneApplication.ts
+++ b/plugins/kubernetes-backend/src/service/standaloneApplication.ts
@@ -25,6 +25,7 @@ import express from 'express';
import helmet from 'helmet';
import { Logger } from 'winston';
import { createRouter } from './router';
+import { ConfigReader } from '@backstage/config';
export interface ApplicationOptions {
enableCors: boolean;
@@ -35,6 +36,7 @@ export async function createStandaloneApplication(
options: ApplicationOptions,
): Promise {
const { enableCors, logger } = options;
+ const config = ConfigReader.fromConfigs([]);
const app = express();
app.use(helmet());
@@ -44,7 +46,7 @@ export async function createStandaloneApplication(
app.use(compression());
app.use(express.json());
app.use(requestLoggingHandler());
- app.use('/', await createRouter({ logger }));
+ app.use('/', await createRouter({ logger, config }));
app.use(notFoundHandler());
app.use(errorHandler());
diff --git a/plugins/kubernetes-backend/src/types/types.ts b/plugins/kubernetes-backend/src/types/types.ts
new file mode 100644
index 0000000000..2c69fd67a0
--- /dev/null
+++ b/plugins/kubernetes-backend/src/types/types.ts
@@ -0,0 +1,103 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+ V1ConfigMap,
+ V1Deployment,
+ V1Pod,
+ V1ReplicaSet,
+ V1Secret,
+ V1Service,
+} from '@kubernetes/client-node';
+
+export interface ClusterDetails {
+ name: string;
+ url: string;
+ // TODO this will eventually be configured by the auth translation work
+ serviceAccountToken: string | undefined;
+}
+
+export interface ClusterObjects {
+ cluster: { name: string };
+ resources: FetchResponse[];
+}
+
+export interface ObjectsByServiceIdResponse {
+ items: ClusterObjects[];
+}
+
+export type FetchResponse =
+ | PodFetchResponse
+ | ServiceFetchResponse
+ | ConfigMapFetchResponse
+ | SecretFetchResponse
+ | DeploymentFetchResponse
+ | ReplicaSetsFetchResponse;
+
+// TODO fairly sure there's a easier way to do this
+
+export type KubernetesObjectTypes =
+ | 'pods'
+ | 'services'
+ | 'configmaps'
+ | 'secrets'
+ | 'deployments'
+ | 'replicasets';
+
+export interface PodFetchResponse {
+ type: 'pods';
+ resources: Array;
+}
+
+export interface ServiceFetchResponse {
+ type: 'services';
+ resources: Array;
+}
+
+export interface ConfigMapFetchResponse {
+ type: 'configmaps';
+ resources: Array;
+}
+
+export interface SecretFetchResponse {
+ type: 'secrets';
+ resources: Array;
+}
+
+export interface DeploymentFetchResponse {
+ type: 'deployments';
+ resources: Array;
+}
+
+export interface ReplicaSetsFetchResponse {
+ type: 'replicasets';
+ resources: Array;
+}
+
+// Fetches information from a kubernetes cluster using the cluster details object
+// to target a specific cluster
+export interface KubernetesFetcher {
+ fetchObjectsByServiceId(
+ serviceId: string,
+ clusterDetails: ClusterDetails,
+ objectTypesToFetch: Set,
+ ): Promise;
+}
+
+// Used to locate which cluster(s) a service is running on
+export interface KubernetesClusterLocator {
+ getClusterByServiceId(serviceId: string): Promise;
+}
diff --git a/plugins/kubernetes/package.json b/plugins/kubernetes/package.json
index d9311deb85..d1f3d5e7ba 100644
--- a/plugins/kubernetes/package.json
+++ b/plugins/kubernetes/package.json
@@ -22,6 +22,7 @@
"dependencies": {
"@backstage/catalog-model": "^0.1.1-alpha.23",
"@backstage/core": "^0.1.1-alpha.23",
+ "@backstage/plugin-kubernetes-backend": "^0.1.1-alpha.23",
"@backstage/theme": "^0.1.1-alpha.23",
"@material-ui/core": "^4.11.0",
"@material-ui/icons": "^4.9.1",
@@ -39,7 +40,9 @@
"@testing-library/user-event": "^12.0.7",
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0",
- "jest-fetch-mock": "^3.0.3"
+ "jest-fetch-mock": "^3.0.3",
+ "msw": "^0.20.5",
+ "node-fetch": "^2.6.1"
},
"files": [
"dist"
diff --git a/plugins/kubernetes/src/Router.tsx b/plugins/kubernetes/src/Router.tsx
index 994788bf72..41f534fbef 100644
--- a/plugins/kubernetes/src/Router.tsx
+++ b/plugins/kubernetes/src/Router.tsx
@@ -22,7 +22,7 @@ import { rootCatalogKubernetesRouteRef } from './plugin';
import { KubernetesContent } from './components/KubernetesContent';
import { WarningPanel } from '@backstage/core';
-const KUBERNETES_ANNOTATION = 'backstage.io/kubernetes';
+const KUBERNETES_ANNOTATION = 'backstage.io/kubernetes-id';
export const Router = ({ entity }: { entity: Entity }) => {
const kubernetesAnnotationValue =
diff --git a/plugins/kubernetes/src/api/KubernetesBackendClient.ts b/plugins/kubernetes/src/api/KubernetesBackendClient.ts
index fed3cd2ed0..cbb3b03a38 100644
--- a/plugins/kubernetes/src/api/KubernetesBackendClient.ts
+++ b/plugins/kubernetes/src/api/KubernetesBackendClient.ts
@@ -16,6 +16,7 @@
import { DiscoveryApi } from '@backstage/core';
import { KubernetesApi } from './types';
+import { ObjectsByServiceIdResponse } from '@backstage/plugin-kubernetes-backend';
export class KubernetesBackendClient implements KubernetesApi {
private readonly discoveryApi: DiscoveryApi;
@@ -37,7 +38,9 @@ export class KubernetesBackendClient implements KubernetesApi {
return await response.json();
}
- async getObjectsByServiceId(serviceId: String): Promise<{}> {
+ async getObjectsByServiceId(
+ serviceId: String,
+ ): Promise {
return await this.getRequired(`/services/${serviceId}`);
}
}
diff --git a/plugins/kubernetes/src/api/types.ts b/plugins/kubernetes/src/api/types.ts
index 2ad6e567f9..5ec3cda6f8 100644
--- a/plugins/kubernetes/src/api/types.ts
+++ b/plugins/kubernetes/src/api/types.ts
@@ -15,6 +15,7 @@
*/
import { createApiRef } from '@backstage/core';
+import { ObjectsByServiceIdResponse } from '@backstage/plugin-kubernetes-backend';
export const kubernetesApiRef = createApiRef({
id: 'plugin.kubernetes.service',
@@ -23,5 +24,5 @@ export const kubernetesApiRef = createApiRef({
});
export interface KubernetesApi {
- getObjectsByServiceId(serviceId: String): Promise<{}>;
+ getObjectsByServiceId(serviceId: String): Promise;
}
diff --git a/plugins/kubernetes/src/components/KubernetesContent/KubernetesContent.tsx b/plugins/kubernetes/src/components/KubernetesContent/KubernetesContent.tsx
index d79454a5d1..bbcef6a0d0 100644
--- a/plugins/kubernetes/src/components/KubernetesContent/KubernetesContent.tsx
+++ b/plugins/kubernetes/src/components/KubernetesContent/KubernetesContent.tsx
@@ -15,25 +15,19 @@
*/
import React, { FC, useEffect, useState } from 'react';
-import { Typography, Grid } from '@material-ui/core';
-import {
- InfoCard,
- Page,
- pageTheme,
- Content,
- ContentHeader,
- useApi,
-} from '@backstage/core';
+import { Grid } from '@material-ui/core';
+import { InfoCard, Page, pageTheme, Content, useApi } from '@backstage/core';
import { Entity } from '@backstage/catalog-model';
import { kubernetesApiRef } from '../../api/types';
+import { ObjectsByServiceIdResponse } from '@backstage/plugin-kubernetes-backend';
// TODO this is a temporary component used to construct the Kubernetes plugin boilerplate
export const KubernetesContent: FC<{ entity: Entity }> = ({ entity }) => {
const kubernetesApi = useApi(kubernetesApiRef);
- const [kubernetesObjects, setKubernetesObjects] = useState<{} | undefined>(
- undefined,
- );
+ const [kubernetesObjects, setKubernetesObjects] = useState<
+ ObjectsByServiceIdResponse | undefined
+ >(undefined);
const [error, setError] = useState(undefined);
useEffect(() => {
@@ -50,21 +44,28 @@ export const KubernetesContent: FC<{ entity: Entity }> = ({ entity }) => {
return (
-
-
-
-
- {kubernetesObjects === undefined && loading....
}
- {error !== undefined && {error}
}
- {kubernetesObjects !== undefined && (
-
- backend response: {JSON.stringify(kubernetesObjects)}
-
- )}
-
-
-
+ {kubernetesObjects === undefined && loading....
}
+ {error !== undefined && {error}
}
+ {kubernetesObjects !== undefined && (
+
+ {kubernetesObjects.items.map((item, i) => (
+
+
+ {item.resources.map((fr, j) => (
+
+
+ {fr.type}:{' '}
+ {(fr.resources as any)
+ .map((v: any) => v.metadata.name)
+ .join(' ')}
+
+ ))}
+
+
+ ))}
+
diff --git a/docs/overview/support.md b/docs/overview/support.md
index 6e00c17fab..12bc7cfaf9 100644
--- a/docs/overview/support.md
+++ b/docs/overview/support.md
@@ -13,10 +13,7 @@ description: Support and Community Details and Links
- [FAQ](../FAQ.md) - Frequently Asked Questions
- [Code of Conduct](../../CODE_OF_CONDUCT.md) - This is how we roll
- [Blog](https://backstage.io/blog/) - Announcements and updates
-- [Newsletter](https://mailchi.mp/spotify/backstage-community)
+- [Newsletter](https://mailchi.mp/spotify/backstage-community) - Subscribe to
+ our email newsletter
- Give us a star ⭐️ - If you are using Backstage or think it is an interesting
project, we would love a star ❤️
-
-Or, if you are an open source developer and are interested in joining our team,
-please reach out to
-[foss-opportunities@spotify.com ](mailto:foss-opportunities@spotify.com)
diff --git a/docs/overview/what-is-backstage.md b/docs/overview/what-is-backstage.md
index 0d16943c9b..3d41c714ee 100644
--- a/docs/overview/what-is-backstage.md
+++ b/docs/overview/what-is-backstage.md
@@ -1,7 +1,7 @@
---
id: what-is-backstage
title: What is Backstage?
-description: Backsatge is an open platform for building developer portals.
+description: Backstage is an open platform for building developer portals.
Powered by a centralized service catalog, Backstage restores order to your microservices and infrastructure
---
@@ -33,7 +33,14 @@ Out of the box, Backstage includes:
[open source plugins](https://github.com/spotify/backstage/tree/master/plugins)
that further expand Backstage’s customizability and functionality
-### Benefits
+## Backstage and the CNCF
+
+Backstage is a CNCF Sandbox project. Read the announcement
+[here](https://backstage.io/blog/2020/09/23/backstage-cncf-sandbox).
+
+