From be70935293c8b2b4d24434c2c9d0e40697a35a1a Mon Sep 17 00:00:00 2001 From: Chanwit Kaewkasi Date: Sun, 31 May 2020 20:24:48 +0700 Subject: [PATCH 01/10] add new plugin to create GitOps-managed Kubernetes clusters with ready-to-use profiles --- packages/app/package.json | 3 +- packages/app/src/plugins.ts | 1 + plugins/gitops-profiles/.eslintrc.js | 3 + plugins/gitops-profiles/dev/index.tsx | 20 ++ plugins/gitops-profiles/package.json | 47 +++ plugins/gitops-profiles/src/api.ts | 170 +++++++++ .../components/ClusterPage/ClusterPage.tsx | 159 ++++++++ .../src/components/ClusterPage/index.ts | 17 + .../components/ClusterTable/ClusterTable.tsx | 69 ++++ .../ClusterTemplateCard.tsx | 102 ++++++ .../components/ClusterTemplateCard/index.ts | 17 + .../ClusterTemplateCardList.tsx | 65 ++++ .../ClusterTemplateCardList/index.ts | 17 + .../components/ProfileCard/ProfileCard.tsx | 109 ++++++ .../src/components/ProfileCard/index.ts | 17 + .../ProfileCardList/ProfileCardList.tsx | 78 ++++ .../src/components/ProfileCardList/index.ts | 17 + .../ProfileCatalog/ProfileCatalog.test.tsx | 36 ++ .../ProfileCatalog/ProfileCatalog.tsx | 338 ++++++++++++++++++ .../src/components/ProfileCatalog/index.ts | 17 + plugins/gitops-profiles/src/index.ts | 18 + plugins/gitops-profiles/src/plugin.test.ts | 23 ++ plugins/gitops-profiles/src/plugin.ts | 28 ++ plugins/gitops-profiles/src/setupTests.ts | 18 + 24 files changed, 1388 insertions(+), 1 deletion(-) create mode 100644 plugins/gitops-profiles/.eslintrc.js create mode 100644 plugins/gitops-profiles/dev/index.tsx create mode 100644 plugins/gitops-profiles/package.json create mode 100644 plugins/gitops-profiles/src/api.ts create mode 100644 plugins/gitops-profiles/src/components/ClusterPage/ClusterPage.tsx create mode 100644 plugins/gitops-profiles/src/components/ClusterPage/index.ts create mode 100644 plugins/gitops-profiles/src/components/ClusterTable/ClusterTable.tsx create mode 100644 plugins/gitops-profiles/src/components/ClusterTemplateCard/ClusterTemplateCard.tsx create mode 100644 plugins/gitops-profiles/src/components/ClusterTemplateCard/index.ts create mode 100644 plugins/gitops-profiles/src/components/ClusterTemplateCardList/ClusterTemplateCardList.tsx create mode 100644 plugins/gitops-profiles/src/components/ClusterTemplateCardList/index.ts create mode 100644 plugins/gitops-profiles/src/components/ProfileCard/ProfileCard.tsx create mode 100644 plugins/gitops-profiles/src/components/ProfileCard/index.ts create mode 100644 plugins/gitops-profiles/src/components/ProfileCardList/ProfileCardList.tsx create mode 100644 plugins/gitops-profiles/src/components/ProfileCardList/index.ts create mode 100644 plugins/gitops-profiles/src/components/ProfileCatalog/ProfileCatalog.test.tsx create mode 100644 plugins/gitops-profiles/src/components/ProfileCatalog/ProfileCatalog.tsx create mode 100644 plugins/gitops-profiles/src/components/ProfileCatalog/index.ts create mode 100644 plugins/gitops-profiles/src/index.ts create mode 100644 plugins/gitops-profiles/src/plugin.test.ts create mode 100644 plugins/gitops-profiles/src/plugin.ts create mode 100644 plugins/gitops-profiles/src/setupTests.ts diff --git a/packages/app/package.json b/packages/app/package.json index ed2f547ad7..6d9c5acc69 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -8,14 +8,15 @@ "@backstage/plugin-catalog": "^0.1.1-alpha.6", "@backstage/plugin-circleci": "^0.1.1-alpha.6", "@backstage/plugin-explore": "^0.1.1-alpha.6", + "@backstage/plugin-gitops-profiles": "^0.1.1-alpha.6", "@backstage/plugin-home-page": "^0.1.1-alpha.6", "@backstage/plugin-lighthouse": "^0.1.1-alpha.6", "@backstage/plugin-register-component": "^0.1.1-alpha.6", "@backstage/plugin-scaffolder": "^0.1.1-alpha.6", + "@backstage/plugin-sentry": "^0.1.1-alpha.6", "@backstage/plugin-tech-radar": "^0.1.1-alpha.6", "@backstage/plugin-welcome": "^0.1.1-alpha.6", "@backstage/theme": "^0.1.1-alpha.6", - "@backstage/plugin-sentry": "^0.1.1-alpha.6", "@material-ui/core": "^4.9.1", "@material-ui/icons": "^4.9.1", "prop-types": "^15.7.2", diff --git a/packages/app/src/plugins.ts b/packages/app/src/plugins.ts index 25a5bcfc9d..2cf2bde9d5 100644 --- a/packages/app/src/plugins.ts +++ b/packages/app/src/plugins.ts @@ -23,3 +23,4 @@ export { plugin as Explore } from '@backstage/plugin-explore'; export { plugin as Circleci } from '@backstage/plugin-circleci'; export { plugin as RegisterComponent } from '@backstage/plugin-register-component'; export { plugin as Sentry } from '@backstage/plugin-sentry'; +export { plugin as GitopsProfiles } from '@backstage/plugin-gitops-profiles'; diff --git a/plugins/gitops-profiles/.eslintrc.js b/plugins/gitops-profiles/.eslintrc.js new file mode 100644 index 0000000000..13573efa9c --- /dev/null +++ b/plugins/gitops-profiles/.eslintrc.js @@ -0,0 +1,3 @@ +module.exports = { + extends: [require.resolve('@backstage/cli/config/eslint')], +}; diff --git a/plugins/gitops-profiles/dev/index.tsx b/plugins/gitops-profiles/dev/index.tsx new file mode 100644 index 0000000000..812a5585d4 --- /dev/null +++ b/plugins/gitops-profiles/dev/index.tsx @@ -0,0 +1,20 @@ +/* + * 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 { createDevApp } from '@backstage/dev-utils'; +import { plugin } from '../src/plugin'; + +createDevApp().registerPlugin(plugin).render(); diff --git a/plugins/gitops-profiles/package.json b/plugins/gitops-profiles/package.json new file mode 100644 index 0000000000..3e6885c0db --- /dev/null +++ b/plugins/gitops-profiles/package.json @@ -0,0 +1,47 @@ +{ + "name": "@backstage/plugin-gitops-profiles", + "version": "0.1.1-alpha.6", + "main": "dist/index.esm.js", + "main:src": "src/index.ts", + "types": "src/index.ts", + "license": "Apache-2.0", + "private": true, + "publishConfig": { + "access": "public" + }, + "scripts": { + "build": "backstage-cli plugin:build", + "start": "backstage-cli plugin:serve", + "lint": "backstage-cli lint", + "test": "backstage-cli test", + "diff": "backstage-cli plugin:diff", + "prepack": "backstage-cli prepack", + "postpack": "backstage-cli postpack", + "clean": "backstage-cli clean" + }, + "dependencies": { + "@backstage/core": "^0.1.1-alpha.6", + "@backstage/theme": "^0.1.1-alpha.6", + "@material-ui/core": "^4.9.1", + "@material-ui/icons": "^4.9.1", + "@material-ui/lab": "4.0.0-alpha.45", + "react": "^16.13.1", + "react-dom": "^16.13.1", + "react-use": "^14.2.0", + "react-router-dom": "^5.2.0" + }, + "devDependencies": { + "@backstage/cli": "^0.1.1-alpha.6", + "@backstage/dev-utils": "^0.1.1-alpha.6", + "@testing-library/jest-dom": "^5.7.0", + "@testing-library/react": "^9.3.2", + "@testing-library/user-event": "^10.2.4", + "@types/jest": "^25.2.2", + "@types/node": "^12.0.0", + "@types/testing-library__jest-dom": "^5.0.4", + "jest-fetch-mock": "^3.0.3" + }, + "files": [ + "dist/**/*.{js,d.ts}" + ] +} diff --git a/plugins/gitops-profiles/src/api.ts b/plugins/gitops-profiles/src/api.ts new file mode 100644 index 0000000000..ad95b1cd52 --- /dev/null +++ b/plugins/gitops-profiles/src/api.ts @@ -0,0 +1,170 @@ +/* + * 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 { createApiRef } from '@backstage/core-api'; + +export interface CloneFromTemplateRequest { + templateRepository: string; + secrets: { + awsAccessKeyId: string; + awsSecretAccessKey: string; + }; + targetOrg: string; + targetRepo: string; + gitHubUser: string; + gitHubToken: string; +} + +export interface ApplyProfileRequest { + targetOrg: string; + targetRepo: string; + gitHubUser: string; + gitHubToken: string; + profiles: string[]; +} + +export interface ChangeClusterStateRequest { + targetOrg: string; + targetRepo: string; + gitHubUser: string; + gitHubToken: string; + clusterState: 'present' | 'absent'; // /api/cluster/state +} + +export interface PollLogRequest { + targetOrg: string; + targetRepo: string; + gitHubUser: string; + gitHubToken: string; +} + +export interface Status { + status: string; // queued, in_progress, or completed + message: string; + conclusion: string; // success, failure, neutral, cancelled, skipped, timed_out, or action_required +} + +export interface StatusResponse { + result: Status[]; + link: string; + status: string; +} + +export interface ClusterStatus { + name: string; + link: string; + status: string; + conclusion: string; + runStatus: Status[]; +} + +export interface ListClusterStatusesResponse { + result: ClusterStatus[]; +} + +export interface ListClusterRequest { + gitHubUser: string; + gitHubToken: string; +} + +export class FetchError extends Error { + get name(): string { + return this.constructor.name; + } + + static async forResponse(resp: Response): Promise { + return new FetchError( + `Request failed with status code ${ + resp.status + }.\nReason: ${await resp.text()}`, + ); + } +} + +export type GitOpsApi = { + url: string; + fetchLog(req: PollLogRequest): Promise; + changeClusterState(req: ChangeClusterStateRequest): Promise; + cloneClusterFromTemplate(req: CloneFromTemplateRequest): Promise; + applyProfiles(req: ApplyProfileRequest): Promise; + listClusters(req: ListClusterRequest): Promise; +}; + +export const gitOpsApiRef = createApiRef({ + id: 'plugin.gitops.service', + description: 'Used by the GitOps profiles plugin to make requests', +}); + +export class GitOpsRestApi implements GitOpsApi { + constructor(public url: string = '') {} + + private async fetch(path: string, init?: RequestInit): Promise { + const resp = await fetch(`${this.url}${path}`, init); + if (!resp.ok) throw await FetchError.forResponse(resp); + return await resp.json(); + } + + async fetchLog(req: PollLogRequest): Promise { + return await this.fetch(`/api/cluster/run-status`, { + method: 'post', + headers: new Headers({ + 'Content-Type': 'application/json', + }), + body: JSON.stringify(req), + }); + } + + async changeClusterState(req: ChangeClusterStateRequest): Promise { + return await this.fetch('/api/cluster/state', { + method: 'post', + headers: new Headers({ + 'Content-Type': 'application/json', + }), + body: JSON.stringify(req), + }); + } + + async cloneClusterFromTemplate(req: CloneFromTemplateRequest): Promise { + return await this.fetch('/api/cluster/clone-from-template', { + method: 'post', + headers: new Headers({ + 'Content-Type': 'application/json', + }), + body: JSON.stringify(req), + }); + } + + async applyProfiles(req: ApplyProfileRequest): Promise { + return await this.fetch('/api/cluster/profiles', { + method: 'post', + headers: new Headers({ + 'Content-Type': 'application/json', + }), + body: JSON.stringify(req), + }); + } + + async listClusters( + req: ListClusterRequest, + ): Promise { + return await this.fetch('/api/clusters', { + method: 'post', + headers: new Headers({ + 'Content-Type': 'application/json', + }), + body: JSON.stringify(req), + }); + } +} diff --git a/plugins/gitops-profiles/src/components/ClusterPage/ClusterPage.tsx b/plugins/gitops-profiles/src/components/ClusterPage/ClusterPage.tsx new file mode 100644 index 0000000000..680459de52 --- /dev/null +++ b/plugins/gitops-profiles/src/components/ClusterPage/ClusterPage.tsx @@ -0,0 +1,159 @@ +/* + * 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 React, { FC, useEffect, useState } from 'react'; +import { + Content, + ContentHeader, + Header, + SupportButton, + Page, + pageTheme, + Table, + Progress, + HeaderLabel, + useApi, +} from '@backstage/core'; +import ClusterTable from '../ClusterTable/ClusterTable'; +import { Button, Link, Typography } from '@material-ui/core'; +import { useParams } from 'react-router-dom'; +import { useAsync, useLocalStorage } from 'react-use'; +import { gitOpsApiRef, ListClusterStatusesResponse, Status } from '../../api'; +import { transformRunStatus } from '../ProfileCatalog'; + +const ClusterPage: FC<{}> = () => { + const params = useParams<{ owner: string; repo: string }>(); + + const [loginInfo] = useLocalStorage<{ + token: string; + username: string; + name: string; + }>('githubLoginDetails'); + const [pollingLog, setPollingLog] = useState(true); + const [runStatus, setRunStatus] = useState([]); + const [runLink, setRunLink] = useState(''); + const [showProgress, setShowProgress] = useState(true); + + const api = useApi(gitOpsApiRef); + + const columns = [ + { field: 'status', title: 'Status' }, + { field: 'message', title: 'Message' }, + ]; + + useEffect(() => { + if (pollingLog) { + const interval = setInterval(async () => { + const resp = await api.fetchLog({ + gitHubToken: loginInfo.token, + gitHubUser: loginInfo.username, + targetOrg: params.owner, + targetRepo: params.repo, + }); + + setRunStatus(resp.result); + setRunLink(resp.link); + if (resp.status === 'completed') { + setPollingLog(false); + setShowProgress(false); + } + }, 10000); + return () => clearInterval(interval); + } + return () => {}; + }, [pollingLog]); + + if (params.owner === undefined || params.repo === undefined) { + const { loading, error, value } = useAsync( + () => { + setPollingLog(false); + return api.listClusters({ + gitHubToken: loginInfo.token, + gitHubUser: loginInfo.username, + }); + }, + ); + let content: JSX.Element; + if (loading) { + content = ( + + + + ); + } else if (error) { + content = ( + + + Failed to load cluster, {String(error)} + + + ); + } else { + content = ( + + + + All clusters + + + + ); + } + + return ( + +
+ +
+ {content} + + ); + } + return ( + +
+ +
+ +