-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 5a287c5
Showing
24 changed files
with
1,178 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
module.exports = require('@backstage/cli/config/eslint-factory')(__dirname, { | ||
extends: ['prettier'], | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# macOS | ||
.DS_Store | ||
|
||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
|
||
# Coverage directory generated when running tests with coverage | ||
coverage | ||
|
||
# Dependencies | ||
node_modules/ | ||
|
||
# Yarn 3 files | ||
.pnp.* | ||
.yarn/* | ||
!.yarn/patches | ||
!.yarn/plugins | ||
!.yarn/releases | ||
!.yarn/sdks | ||
!.yarn/versions | ||
|
||
# Node version directives | ||
.nvmrc | ||
|
||
# dotenv environment variables file | ||
.env | ||
.env.test | ||
|
||
# Build output | ||
dist | ||
dist-types | ||
|
||
# Temporary change files created by Vim | ||
*.swp | ||
|
||
# MkDocs build output | ||
site | ||
|
||
# Local configuration files | ||
*.local.yaml | ||
|
||
# Sensitive credentials | ||
*-credentials.yaml | ||
|
||
# vscode database functionality support files | ||
*.session.sql | ||
|
||
# JetBrains | ||
.idea | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
build | ||
coverage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Apache Spark Plugin for Backstage | ||
|
||
Welcome to the Apache Spark plugin for Backstage! | ||
|
||
This plugin allows you to display information related to your Apache Spark Applications running in Kubernetes on Backstage | ||
|
||
## Getting started | ||
|
||
 | ||
|
||
|
||
### Configuration | ||
|
||
Entities must be annotated with Kubernetes annotations. For example: | ||
|
||
[The Kubernetes plugin](https://backstage.io/docs/features/kubernetes/) must also be installed and enabled. | ||
|
||
```yaml | ||
apiVersion: backstage.io/v1alpha1 | ||
kind: Component | ||
metadata: | ||
name: backstage | ||
annotations: | ||
backstage.io/kubernetes-namespace: default | ||
backstage.io/kubernetes-label-selector: env=dev,my=label | ||
``` | ||
Update your Entity page. For example: | ||
```typescript | ||
// in packages/app/src/components/catalog/EntityPage.tsx | ||
|
||
``` | ||
|
||
|
||
#### Annotations | ||
- `backstage.io/kubernetes-namespace`: Optional. Defaults to the `default` namespace. | ||
- `backstage.io/kubernetes-label-selector`: Conditionally required. One of label selectors must be defined. | ||
- `apache-spark/label-selector`: Conditionally required. One of label selectors must be defined. This value takes precedent over the one above. | ||
- `apache-spark/cluster-name`: Optional. Specifies the name of Kubernetes cluster to retrieve information from. | ||
|
||
### Authentication | ||
|
||
This plugin uses the Kubernetes plugin for authentication. | ||
|
||
#### Using configured Kubernetes API | ||
|
||
The plugin uses configured Kubernetes clusters to fetch resources. | ||
|
||
For example, for a Kubernetes cluster given in your `app-config.yaml` | ||
|
||
```yaml | ||
kubernetes: | ||
serviceLocatorMethod: | ||
type: "multiTenant" | ||
clusterLocatorMethods: | ||
- type: "config" | ||
clusters: | ||
- url: https://abcd.gr7.us-west-2.eks.amazonaws.com:443 | ||
name: my-cluster-1 | ||
authProvider: "serviceAccount" | ||
serviceAccountToken: eyJh | ||
caData: LS0t | ||
``` | ||
For this configuration, the `argo-workflows/cluster-name` annotation value must be `my-cluster-1`. If this is not specified, the first cluster in the list is selected. | ||
|
||
```yaml | ||
apiVersion: backstage.io/v1alpha1 | ||
kind: Component | ||
metadata: | ||
name: backstage | ||
annotations: | ||
backstage.io/kubernetes-namespace: default | ||
backstage.io/kubernetes-label-selector: env=dev,my=label | ||
argo-workflows/cluster-name: my-cluster-1 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import React from 'react'; | ||
import { createDevApp } from '@backstage/dev-utils'; | ||
import { apacheSparkPlugin, ApacheSparkPage } from '../src/plugin'; | ||
|
||
createDevApp() | ||
.registerPlugin(apacheSparkPlugin) | ||
.addPage({ | ||
element: <ApacheSparkPage />, | ||
title: 'Root Page', | ||
path: '/apache-spark' | ||
}) | ||
.render(); |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
{ | ||
"name": "@internal/plugin-apache-spark", | ||
"version": "0.1.0", | ||
"main": "src/index.ts", | ||
"types": "src/index.ts", | ||
"license": "Apache-2.0", | ||
"private": true, | ||
"publishConfig": { | ||
"access": "public", | ||
"main": "dist/index.esm.js", | ||
"types": "dist/index.d.ts" | ||
}, | ||
"backstage": { | ||
"role": "frontend-plugin" | ||
}, | ||
"scripts": { | ||
"start": "backstage-cli package start", | ||
"build": "backstage-cli package build", | ||
"lint": "backstage-cli package lint", | ||
"test": "backstage-cli package test", | ||
"clean": "backstage-cli package clean", | ||
"prepack": "backstage-cli package prepack", | ||
"postpack": "backstage-cli package postpack" | ||
}, | ||
"dependencies": { | ||
"@backstage/core-components": "^0.13.1", | ||
"@backstage/core-plugin-api": "^1.5.1", | ||
"@backstage/plugin-catalog-react": "^1.7.0", | ||
"@backstage/plugin-kubernetes": "^0.9.2", | ||
"@backstage/theme": "^0.3.0", | ||
"@material-ui/core": "^4.12.2", | ||
"@material-ui/icons": "^4.9.1", | ||
"@material-ui/lab": "4.0.0-alpha.61", | ||
"react-use": "^17.2.4", | ||
"yaml": "^2.3.1" | ||
}, | ||
"peerDependencies": { | ||
"react": "^16.13.1 || ^17.0.0", | ||
"react-router-dom": "^6.14.1" | ||
}, | ||
"devDependencies": { | ||
"@backstage/cli": "^0.22.7", | ||
"@backstage/core-app-api": "^1.8.0", | ||
"@backstage/dev-utils": "^1.0.15", | ||
"@backstage/test-utils": "^1.3.1", | ||
"@testing-library/jest-dom": "^5.10.1", | ||
"@testing-library/react": "^12.1.3", | ||
"@testing-library/user-event": "^14.0.0", | ||
"@types/node": "*", | ||
"cross-fetch": "^3.1.5", | ||
"msw": "^1.0.0" | ||
}, | ||
"files": [ | ||
"dist" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# | ||
# Copyright 2017 Google LLC | ||
# | ||
# 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 | ||
# | ||
# https://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. | ||
|
||
apiVersion: "sparkoperator.k8s.io/v1beta2" | ||
kind: SparkApplication | ||
metadata: | ||
# name: spark-pi | ||
generateName: spark-pi | ||
namespace: default | ||
spec: | ||
type: Python | ||
pythonVersion: "3" | ||
mode: cluster | ||
image: "public.ecr.aws/r1l5w1y9/spark-operator:3.2.1-hadoop-3.3.1-java-11-scala-2.12-python-3.8-latest" | ||
mainApplicationFile: "local:///opt/spark/examples/src/main/python/pi.py" | ||
sparkVersion: "3.1.1" | ||
restartPolicy: | ||
type: Never | ||
volumes: | ||
- name: "test-volume" | ||
hostPath: | ||
path: "/tmp" | ||
type: Directory | ||
driver: | ||
cores: 1 | ||
coreLimit: "1200m" | ||
memory: "512m" | ||
labels: | ||
version: 3.1.1 | ||
serviceAccount: spark | ||
volumeMounts: | ||
- name: "test-volume" | ||
mountPath: "/tmp" | ||
executor: | ||
cores: 1 | ||
instances: 1 | ||
memory: "512m" | ||
labels: | ||
version: 3.1.1 | ||
volumeMounts: | ||
- name: "test-volume" | ||
mountPath: "/tmp" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# | ||
# Copyright 2017 Google LLC | ||
# | ||
# 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 | ||
# | ||
# https://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. | ||
|
||
apiVersion: "sparkoperator.k8s.io/v1beta2" | ||
kind: SparkApplication | ||
metadata: | ||
# name: spark-pi | ||
generateName: spark-pi | ||
namespace: default | ||
spec: | ||
type: Python | ||
pythonVersion: "3" | ||
mode: cluster | ||
image: "public.ecr.aws/m8u6z8z4/manabu-test:test-spark" | ||
mainApplicationFile: "local:///opt/spark/examples/src/main/python/pi.py" | ||
sparkVersion: "3.1.1" | ||
restartPolicy: | ||
type: Never | ||
volumes: | ||
- name: "test-volume" | ||
hostPath: | ||
path: "/tmp" | ||
type: Directory | ||
driver: | ||
cores: 1 | ||
coreLimit: "1200m" | ||
memory: "512m" | ||
labels: | ||
version: 3.1.1 | ||
serviceAccount: spark | ||
volumeMounts: | ||
- name: "test-volume" | ||
mountPath: "/tmp" | ||
executor: | ||
cores: 1 | ||
instances: 1 | ||
memory: "512m" | ||
labels: | ||
version: 3.1.1 | ||
volumeMounts: | ||
- name: "test-volume" | ||
mountPath: "/tmp" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
apiVersion: v1 | ||
kind: ServiceAccount | ||
metadata: | ||
name: spark | ||
namespace: default | ||
--- | ||
apiVersion: rbac.authorization.k8s.io/v1 | ||
kind: Role | ||
metadata: | ||
namespace: default | ||
name: spark-role | ||
rules: | ||
- apiGroups: [""] | ||
resources: ["pods"] | ||
verbs: ["*"] | ||
- apiGroups: [""] | ||
resources: ["services"] | ||
verbs: ["*"] | ||
- apiGroups: [""] | ||
resources: ["configmaps"] | ||
verbs: ["*"] | ||
--- | ||
apiVersion: rbac.authorization.k8s.io/v1 | ||
kind: RoleBinding | ||
metadata: | ||
name: spark-role-binding | ||
namespace: default | ||
subjects: | ||
- kind: ServiceAccount | ||
name: spark | ||
namespace: default | ||
roleRef: | ||
kind: Role | ||
name: spark-role | ||
apiGroup: rbac.authorization.k8s.io |
Oops, something went wrong.