DevFW-CICD/backstage-edp
12
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

Updated argoworkflows to query workflows based on component annotation (#34)

Browse source 
Signed-off-by: Mani Marothu <manikumar.1215@gmail.com>
This commit is contained in:
Mani Marothu 2024-09-16 17:38:26 -07:00 committed by GitHub
parent 2cde0a09ca
commit 5f3a54f571
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 52 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
plugins/argo-workflows/src/api/ArgoWorkflows.ts
View file

@ -33,8 +33,10 @@ export class ArgoWorkflows implements ArgoWorkflowsApi {
namespace: string,
labels: string | undefined
): Promise<IoArgoprojWorkflowV1alpha1WorkflowList> {
const ns = namespace !== undefined ? namespace : "default";
const path = `/apis/${API_VERSION}/namespaces/${ns}/${WORKFLOW_PLURAL}`;
let path = `/apis/${API_VERSION}/${WORKFLOW_PLURAL}`;
if(namespace !== undefined){
path = `/apis/${API_VERSION}/namespaces/${namespace}/${WORKFLOW_PLURAL}`;
}
const query = new URLSearchParams({
[K8s_API_TIMEOUT]: "30",
});

16
plugins/argo-workflows/src/api/index.ts
View file

@ -1,24 +1,24 @@
import { createApiRef } from "@backstage/core-plugin-api";
import { createApiRef } from '@backstage/core-plugin-api';
import {
IoArgoprojWorkflowV1alpha1WorkflowList,
IoArgoprojWorkflowV1alpha1WorkflowTemplateList,
} from "./generated/api";
} from './generated/api';
export { ArgoWorkflows } from "./ArgoWorkflows";
export { ArgoWorkflows } from './ArgoWorkflows';
export const argoWorkflowsApiRef = createApiRef<ArgoWorkflowsApi>({
id: "plugin.argoworkflows",
id: 'plugin.argoworkflows',
});
export interface ArgoWorkflowsApi {
getWorkflows(
clusterName: string | undefined,
namespace: string | undefined,
labels: string | undefined
labels: string | undefined,
): Promise<IoArgoprojWorkflowV1alpha1WorkflowList>;
getWorkflowTemplates(
clusterName: string | undefined,
namespace: string,
labels: string | undefined
namespace: string | undefined,
labels: string | undefined,
): Promise<IoArgoprojWorkflowV1alpha1WorkflowTemplateList>;
}
}

24
plugins/argo-workflows/src/components/utils.ts
View file

@ -1,33 +1,39 @@
import {Entity} from "@backstage/catalog-model";
import { Entity } from '@backstage/catalog-model';
import {
ARGO_WORKFLOWS_LABEL_SELECTOR_ANNOTATION,
CLUSTER_NAME_ANNOTATION,
K8S_NAMESPACE_ANNOTATION,
} from "../plugin";
ARGO_WORKFLOWS_NAMESPACE_ANNOTATION,
} from '../plugin';
export function trimBaseUrl(argoWorkflowsBaseUrl: string | undefined) {
if (argoWorkflowsBaseUrl && argoWorkflowsBaseUrl.endsWith("/")) {
if (argoWorkflowsBaseUrl && argoWorkflowsBaseUrl.endsWith('/')) {
return argoWorkflowsBaseUrl.substring(0, argoWorkflowsBaseUrl.length - 1);
}
return argoWorkflowsBaseUrl;
}
export type getAnnotationValuesOutput = {
ns: string;
ns?: string;
clusterName?: string;
labelSelector?: string;
};
export function getAnnotationValues(entity: Entity): getAnnotationValuesOutput {
const ns =
let ns = entity.metadata.annotations?.[ARGO_WORKFLOWS_NAMESPACE_ANNOTATION];
if (
entity.metadata.annotations?.[ARGO_WORKFLOWS_NAMESPACE_ANNOTATION] ===
undefined &&
entity.metadata.annotations?.[K8S_NAMESPACE_ANNOTATION] !== undefined
? entity.metadata.annotations?.[K8S_NAMESPACE_ANNOTATION]
: "default";
) {
ns = entity.metadata.annotations?.[K8S_NAMESPACE_ANNOTATION];
}
const clusterName = entity.metadata.annotations?.[CLUSTER_NAME_ANNOTATION];
const labelSelector = entity.metadata?.annotations?.[ARGO_WORKFLOWS_LABEL_SELECTOR_ANNOTATION]
const labelSelector =
entity.metadata?.annotations?.[ARGO_WORKFLOWS_LABEL_SELECTOR_ANNOTATION];
return {
ns: ns,
clusterName: clusterName,
labelSelector: labelSelector,
};
}
}

46
plugins/argo-workflows/src/plugin.ts
View file

@ -4,20 +4,22 @@ import {
createRoutableExtension,
discoveryApiRef,
fetchApiRef,
} from "@backstage/core-plugin-api";
import {Entity} from "@backstage/catalog-model";
} from '@backstage/core-plugin-api';
import { Entity } from '@backstage/catalog-model';
import {rootRouteRef} from "./routes";
import {ArgoWorkflows, argoWorkflowsApiRef} from "./api";
import {kubernetesApiRef} from "@backstage/plugin-kubernetes";
import { rootRouteRef } from './routes';
import { ArgoWorkflows, argoWorkflowsApiRef } from './api';
import { kubernetesApiRef } from '@backstage/plugin-kubernetes';
export const CLUSTER_NAME_ANNOTATION = "argo-workflows.cnoe.io/cluster-name";
export const K8S_NAMESPACE_ANNOTATION = "backstage.io/kubernetes-namespace";
export const CLUSTER_NAME_ANNOTATION = 'argo-workflows.cnoe.io/cluster-name';
export const K8S_NAMESPACE_ANNOTATION = 'backstage.io/kubernetes-namespace';
export const ARGO_WORKFLOWS_NAMESPACE_ANNOTATION =
'argo-workflows.cnoe.io/namespace';
export const ARGO_WORKFLOWS_LABEL_SELECTOR_ANNOTATION =
"argo-workflows.cnoe.io/label-selector";
'argo-workflows.cnoe.io/label-selector';
export const argoWorkflowsPlugin = createPlugin({
id: "argo-workflows",
id: 'argo-workflows',
routes: {
root: rootRouteRef,
},
@ -29,7 +31,7 @@ export const argoWorkflowsPlugin = createPlugin({
kubernetesApi: kubernetesApiRef,
fetchApi: fetchApiRef,
},
factory: ({discoveryApi, kubernetesApi, fetchApi}) =>
factory: ({ discoveryApi, kubernetesApi, fetchApi }) =>
new ArgoWorkflows(discoveryApi, kubernetesApi, fetchApi),
}),
],
@ -37,33 +39,35 @@ export const argoWorkflowsPlugin = createPlugin({
export const ArgoWorkflowsPage = argoWorkflowsPlugin.provide(
createRoutableExtension({
name: "ArgoWorkflowsPage",
name: 'ArgoWorkflowsPage',
component: () =>
import("./components/Overview").then((m) => m.ArgoWorkflowsOverviewPage),
import('./components/Overview').then(m => m.ArgoWorkflowsOverviewPage),
mountPoint: rootRouteRef,
})
}),
);
export const EntityArgoWorkflowsOverviewCard = argoWorkflowsPlugin.provide(
createRoutableExtension({
name: "ArgoWorkflowsOverviewCard",
name: 'ArgoWorkflowsOverviewCard',
component: () =>
import("./components/Overview").then((m) => m.ArgoWorkflowsOverviewCard),
import('./components/Overview').then(m => m.ArgoWorkflowsOverviewCard),
mountPoint: rootRouteRef,
})
}),
);
export const EntityArgoWorkflowsTemplateOverviewCard =
argoWorkflowsPlugin.provide(
createRoutableExtension({
name: "ArgoWorkflowsTemplatesOverviewCard",
name: 'ArgoWorkflowsTemplatesOverviewCard',
component: () =>
import("./components/Overview").then(
(m) => m.ArgoWorkflowsTemplatesOverviewCard
import('./components/Overview').then(
m => m.ArgoWorkflowsTemplatesOverviewCard,
),
mountPoint: rootRouteRef,
})
}),
);
export const isArgoWorkflowsAvailable = (entity: Entity) =>
Boolean(entity?.metadata.annotations?.[ARGO_WORKFLOWS_LABEL_SELECTOR_ANNOTATION]);
Boolean(
entity?.metadata.annotations?.[ARGO_WORKFLOWS_LABEL_SELECTOR_ANNOTATION],
);