Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

refactor(frontend): migrate GitOps page to React (#19854)

Danny Xu9ab6d2e9b67c
diff --git a/frontend/src/react/ProjectGitOpsPageMount.vue b/frontend/src/react/ProjectGitOpsPageMount.vue
new file mode 100644
index 0000000000..55cf5da2f3
--- /dev/null
+++ b/frontend/src/react/ProjectGitOpsPageMount.vue
@@ -0,0 +1,49 @@
+<template>
+ <div ref="container" class="h-full" />
+</template>
+
+<script lang="ts" setup>
+import { onMounted, onUnmounted, ref, watch } from "vue";
+import { useI18n } from "vue-i18n";
+
+const props = defineProps<{
+ projectId: string;
+}>();
+
+const { locale } = useI18n();
+const container = ref<HTMLElement>();
+// biome-ignore lint/suspicious/noExplicitAny: React Root type from dynamic import
+let root: any = null; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+async function render() {
+ if (!container.value) return;
+ const [{ mountReactPage, updateReactPage }, i18nModule] = await Promise.all([
+ import("./mount"),
+ import("./i18n"),
+ ]);
+ if (i18nModule.default.language !== locale.value) {
+ await i18nModule.default.changeLanguage(locale.value);
+ }
+ const pageProps = { projectId: props.projectId };
+ if (!root) {
+ root = await mountReactPage(
+ container.value,
+ "ProjectGitOpsPage",
+ pageProps
+ );
+ } else {
+ await updateReactPage(root, "ProjectGitOpsPage", pageProps);
+ }
+}
+
+onMounted(() => render());
+watch(locale, () => render());
+watch(
+ () => props.projectId,
+ () => render()
+);
+onUnmounted(() => {
+ root?.unmount();
+ root = null;
+});
+</script>
diff --git a/frontend/src/react/components/CreateWorkloadIdentityDrawer.tsx b/frontend/src/react/components/CreateWorkloadIdentityDrawer.tsx
new file mode 100644
index 0000000000..5fd94bb376
--- /dev/null
+++ b/frontend/src/react/components/CreateWorkloadIdentityDrawer.tsx
@@ -0,0 +1,623 @@
+import { create } from "@bufbuild/protobuf";
+import { FieldMaskSchema } from "@bufbuild/protobuf/wkt";
+import { ChevronDown, ChevronUp, X } from "lucide-react";
+import { useEffect, useMemo, useRef, useState } from "react";
+import { useTranslation } from "react-i18next";
+import { Button } from "@/react/components/ui/button";
+import { Input } from "@/react/components/ui/input";
+import { useEscapeKey } from "@/react/hooks/useEscapeKey";
+import { useVueState } from "@/react/hooks/useVueState";
+import { RoleMultiSelect } from "@/react/pages/settings/shared/RoleMultiSelect";
+import {
+ ensureWorkloadIdentityFullName,
+ pushNotification,
+ useActuatorV1Store,
+ useProjectV1Store,
+ useWorkspaceV1Store,
+} from "@/store";
+import { useProjectIamPolicyStore } from "@/store/modules/v1/projectIamPolicy";
+import { useWorkloadIdentityStore } from "@/store/modules/workloadIdentity";
+import {
+ getWorkloadIdentityNameInBinding,
+ getWorkloadIdentitySuffix,
+} from "@/types";
+import { BindingSchema } from "@/types/proto-es/v1/iam_policy_pb";
+import type { WorkloadIdentity } from "@/types/proto-es/v1/workload_identity_service_pb";
+import {
+ WorkloadIdentityConfig_ProviderType,
+ WorkloadIdentityConfigSchema,
+ WorkloadIdentitySchema,
+} from "@/types/proto-es/v1/workload_identity_service_pb";
+import {
+ getWorkloadIdentityProviderText,
+ hasProjectPermissionV2,
+ hasWorkspacePermissionV2,
+ parseWorkloadIdentitySubjectPattern,
+} from "@/utils";
+
+type RefType = "branch" | "tag" | "all";
+
+const PLATFORM_PRESETS: Partial<
+ Record<
+ WorkloadIdentityConfig_ProviderType,
+ { issuerUrl: string; audience: string }
+ >
+> = {
+ [WorkloadIdentityConfig_ProviderType.GITHUB]: {
+ issuerUrl: "https://token.actions.githubusercontent.com",
+ audience: "",
+ },
+ [WorkloadIdentityConfig_ProviderType.GITLAB]: {
+ issuerUrl: "https://gitlab.com",
+ audience: "",
+ },
+};
+
+function computeSubjectPattern(
+ providerType: WorkloadIdentityConfig_ProviderType,
+ owner: string,
+ repo: string,
+ branch: string,
+ refType: RefType
+): string {
+ if (providerType === WorkloadIdentityConfig_ProviderType.GITHUB) {
+ if (!repo) return `repo:${owner}/*`;
+ if (!branch) return `repo:${owner}/${repo}:*`;
+ return `repo:${owner}/${repo}:ref:refs/heads/${branch}`;
+ }
+ if (providerType === WorkloadIdentityConfig_ProviderType.GITLAB) {
+ if (!repo) return `project_path:${owner}/*`;
+ if (refType === "all" || !branch) return `project_path:${owner}/${repo}:*`;
+ return `project_path:${owner}/${repo}:ref_type:${refType}:ref:${branch}`;
+ }
+ return "";
+}
+
+export function CreateWorkloadIdentityDrawer({
+ workloadIdentity,
+ project,
+ onClose,
+ onCreated,
+ onUpdated,
+}: {
+ workloadIdentity?: WorkloadIdentity;
+ project?: string;
+ onClose: () => void;
+ onCreated: (wi: WorkloadIdentity) => void;
+ onUpdated?: (wi: WorkloadIdentity) => void;
+}) {
+ const { t } = useTranslation();
+ const workloadIdentityStore = useWorkloadIdentityStore();
+ const workspaceStore = useWorkspaceV1Store();
+ const actuatorStore = useActuatorV1Store();
+ const projectStore = useProjectV1Store();
+ const projectIamPolicyStore = useProjectIamPolicyStore();
+
+ const projectEntity = useVueState(() =>
+ project ? projectStore.getProjectByName(project) : undefined
+ );
+
+ const isEditMode = !!workloadIdentity && !!workloadIdentity.email;
+
+ const [title, setTitle] = useState(workloadIdentity?.title ?? "");
+ const [emailPrefix, setEmailPrefix] = useState(() => {
+ if (workloadIdentity?.email) {
+ return workloadIdentity.email.split("@")[0];
+ }
+ return "";
+ });
+
+ const emailSuffix = useMemo(() => {
+ const projectId = project ? project.replace(/^projects\//, "") : "";
+ return getWorkloadIdentitySuffix(projectId || undefined);
+ }, [project]);
+
+ const parent = useMemo(
+ () => project ?? actuatorStore.workspaceResourceName,
+ [project, actuatorStore]
+ );
+
+ const [providerType, setProviderType] =
+ useState<WorkloadIdentityConfig_ProviderType>(
+ workloadIdentity?.workloadIdentityConfig?.providerType ??
+ WorkloadIdentityConfig_ProviderType.GITHUB
+ );
+ const [owner, setOwner] = useState("");
+ const [repo, setRepo] = useState("");
+ const [branch, setBranch] = useState("");
+ const [refType, setRefType] = useState<RefType>("all");
+ const [issuerUrl, setIssuerUrl] = useState(
+ PLATFORM_PRESETS[WorkloadIdentityConfig_ProviderType.GITHUB]!.issuerUrl
+ );
+ const [audience, setAudience] = useState("");
+ const [subjectPattern, setSubjectPattern] = useState("");
+ const [showAdvanced, setShowAdvanced] = useState(false);
+ const [roles, setRoles] = useState<string[]>([]);
+ const [isRequesting, setIsRequesting] = useState(false);
+
+ const isUpdatingFromPatternRef = useRef(false);
+ const isUpdatingFromFieldsRef = useRef(false);
+
+ useEffect(() => {
+ if (!workloadIdentity) return;
+ setTitle(workloadIdentity.title);
+ setEmailPrefix(workloadIdentity.email.split("@")[0]);
+
+ const config = workloadIdentity.workloadIdentityConfig;
+ if (config) {
+ setProviderType(config.providerType);
+ setIssuerUrl(config.issuerUrl);
+ setAudience(config.allowedAudiences[0] ?? "");
+ setSubjectPattern(config.subjectPattern);
+
+ const parsed = parseWorkloadIdentitySubjectPattern(workloadIdentity);
+ if (parsed) {
+ setOwner(parsed.owner);
+ setRepo(parsed.repo);
+ setBranch(parsed.branch);
+ if ("refType" in parsed && parsed.refType) {
+ setRefType(parsed.refType);
+ }
+ }
+ }
+ }, []);
+
+ useEffect(() => {
+ if (isUpdatingFromPatternRef.current) return;
+ isUpdatingFromFieldsRef.current = true;
+ setSubjectPattern(
+ computeSubjectPattern(providerType, owner, repo, branch, refType)
+ );
+ isUpdatingFromFieldsRef.current = false;
+ }, [owner, repo, branch, providerType, refType]);
+
+ useEffect(() => {
+ if (isUpdatingFromFieldsRef.current) return;
+ const parsed = parseWorkloadIdentitySubjectPattern({
+ workloadIdentityConfig: {
+ subjectPattern,
+ providerType,
+ },
+ });
+ if (parsed) {
+ isUpdatingFromPatternRef.current = true;
+ setOwner(parsed.owner);
+ setRepo(parsed.repo);
+ setBranch(parsed.branch);
+ if ("refType" in parsed && parsed.refType) {
+ setRefType(parsed.refType);
+ }
+ isUpdatingFromPatternRef.current = false;
+ }
+ }, [subjectPattern]);
+
+ useEscapeKey(true, onClose);
+
+ const handlePlatformChange = (value: WorkloadIdentityConfig_ProviderType) => {
+ setProviderType(value);
+ const preset = PLATFORM_PRESETS[value];
+ if (preset) {
+ setIssuerUrl(preset.issuerUrl);
+ setAudience(preset.audience);
+ }
+ setRefType("all");
+ setBranch("");
+ };
+
+ const allowConfirm = useMemo(() => {
+ if (!emailPrefix && !workloadIdentity?.email) return false;
+ if (!owner) return false;
+ if (!issuerUrl) return false;
+ return true;
+ }, [emailPrefix, workloadIdentity?.email, owner, issuerUrl]);
+
+ const requiredPermission = isEditMode
+ ? "bb.workloadIdentities.update"
+ : "bb.workloadIdentities.create";
+ const hasPermission = projectEntity
+ ? hasProjectPermissionV2(projectEntity, requiredPermission)
+ : hasWorkspacePermissionV2(requiredPermission);
+
+ const handleSubmit = async () => {
+ if (!allowConfirm || !hasPermission) return;
+ setIsRequesting(true);
+ try {
+ if (isEditMode) {
+ await handleUpdate();
+ } else {
+ await handleCreate();
+ }
+ } catch {
+ // error shown by store
+ } finally {
+ setIsRequesting(false);
+ }
+ };
+
+ const updateProjectIamPolicyForMember = async (
+ projectName: string,
+ member: string,
+ newRoles: string[]
+ ) => {
+ const policy = structuredClone(
+ projectIamPolicyStore.getProjectIamPolicy(projectName)
+ );
+ for (const binding of policy.bindings) {
+ binding.members = binding.members.filter((m) => m !== member);
+ }
+ policy.bindings = policy.bindings.filter(
+ (binding) => binding.members.length > 0
+ );
+ for (const role of newRoles) {
+ const existing = policy.bindings.find((b) => b.role === role);
+ if (existing) {
+ if (!existing.members.includes(member)) {
+ existing.members.push(member);
+ }
+ } else {
+ policy.bindings.push(
+ create(BindingSchema, { role, members: [member] })
+ );
+ }
+ }
+ await projectIamPolicyStore.updateProjectIamPolicy(projectName, policy);
+ };
+
+ const handleCreate = async () => {
+ const wi = await workloadIdentityStore.createWorkloadIdentity(
+ emailPrefix,
+ {
+ title: title || emailPrefix,
+ workloadIdentityConfig: create(WorkloadIdentityConfigSchema, {
+ providerType,
+ issuerUrl,
+ allowedAudiences: audience ? [audience] : [],
+ subjectPattern,
+ }),
+ },
+ parent
+ );
+
+ if (roles.length > 0) {
+ const member = getWorkloadIdentityNameInBinding(wi.email);
+ if (projectEntity) {
+ await updateProjectIamPolicyForMember(
+ projectEntity.name,
+ member,
+ roles
+ );
+ } else {
+ await workspaceStore.patchIamPolicy([{ member, roles }]);
+ }
+ }
+
+ onCreated(wi);
+ pushNotification({
+ module: "bytebase",
+ style: "SUCCESS",
+ title: t("common.created"),
+ });
+ onClose();
+ };
+
+ const handleUpdate = async () => {
+ if (!workloadIdentity) return;
+
+ const updateMask: string[] = [];
+ if (title !== workloadIdentity.title) {
+ updateMask.push("title");
+ }
+
+ const updated = await workloadIdentityStore.updateWorkloadIdentity(
+ create(WorkloadIdentitySchema, {
+ name: ensureWorkloadIdentityFullName(workloadIdentity.email),
+ title,
+ workloadIdentityConfig: create(WorkloadIdentityConfigSchema, {
+ providerType,
+ issuerUrl,
+ allowedAudiences: audience ? [audience] : [],
+ subjectPattern,
+ }),
+ }),
+ create(FieldMaskSchema, {
+ paths: [...updateMask, "workload_identity_config"],
+ })
+ );
+
+ onUpdated?.(updated);
+ pushNotification({
+ module: "bytebase",
+ style: "SUCCESS",
+ title: t("common.updated"),
+ });
+ onClose();
+ };
+
+ const isGitLab = providerType === WorkloadIdentityConfig_ProviderType.GITLAB;
+ const showBranchField =
+ providerType === WorkloadIdentityConfig_ProviderType.GITHUB ||
+ refType !== "all";
+ const isTagRefType = isGitLab && refType === "tag";
+
+ return (
+ <>
+ {/* Backdrop */}
+ <div className="fixed inset-0 z-40 bg-black/30" onClick={onClose} />
+
+ {/* Drawer */}
+ <div
+ role="dialog"
+ aria-modal="true"
+ className="fixed inset-y-0 right-0 z-50 w-[40rem] max-w-[100vw] bg-white shadow-xl flex flex-col"
+ >
+ {/* Header */}
+ <div className="flex items-center justify-between px-6 py-4 border-b">
+ <h2 className="text-lg font-medium">
+ {isEditMode
+ ? t("settings.members.update-workload-identity")
+ : t("settings.members.add-workload-identity")}
+ </h2>
+ <Button variant="ghost" size="icon" onClick={onClose}>
+ <X className="h-5 w-5" />
+ </Button>
+ </div>
+
+ {/* Content */}
+ <div className="flex-1 overflow-auto px-6 py-6">
+ <div className="flex flex-col gap-y-6">
+ {/* Title */}
+ <div className="flex flex-col gap-y-2">
+ <label className="block text-sm font-medium text-control">
+ {t("common.name")}
+ </label>
+ <Input
+ value={title}
+ onChange={(e) => setTitle(e.target.value)}
+ placeholder="GitHub Deploy"
+ maxLength={200}
+ autoComplete="off"
+ />
+ </div>
+
+ {/* Email */}
+ <div className="flex flex-col gap-y-2">
+ <label className="block text-sm font-medium text-control">
+ {t("common.email")}
+ <span className="ml-0.5 text-error">*</span>
+ </label>
+ {isEditMode ? (
+ <Input value={workloadIdentity!.email} disabled />
+ ) : (
+ <div className="flex items-center">
+ <Input
+ value={emailPrefix}
+ onChange={(e) => setEmailPrefix(e.target.value)}
+ placeholder="my-workflow"
+ autoComplete="off"
+ className="rounded-r-none"
+ />
+ <span className="inline-flex items-center px-3 h-9 border border-l-0 border-control-border bg-control-bg text-sm text-control rounded-r-xs whitespace-nowrap">
+ @{emailSuffix}
+ </span>
+ </div>
+ )}
+ </div>
+
+ {/* Platform */}
+ <div className="flex flex-col gap-y-2">
+ <label className="block text-sm font-medium text-control">
+ {t("settings.members.workload-identity-platform")}
+ <span className="ml-0.5 text-error">*</span>
+ </label>
+ <select
+ value={providerType}
+ onChange={(e) =>
+ handlePlatformChange(
+ Number(
+ e.target.value
+ ) as WorkloadIdentityConfig_ProviderType
+ )
+ }
+ className="border border-control-border rounded-xs text-sm px-2 py-2 bg-white"
+ >
+ {[
+ WorkloadIdentityConfig_ProviderType.GITHUB,
+ WorkloadIdentityConfig_ProviderType.GITLAB,
+ ].map((pt) => (
+ <option key={pt} value={pt}>
+ {getWorkloadIdentityProviderText(pt)}
+ </option>
+ ))}
+ </select>
+ </div>
+
+ {/* Owner / Group */}
+ <div className="flex flex-col gap-y-2">
+ <label className="block text-sm font-medium text-control">
+ {isGitLab
+ ? t("settings.members.workload-identity-group")
+ : t("settings.members.workload-identity-owner")}
+ <span className="ml-0.5 text-error">*</span>
+ </label>
+ <Input
+ value={owner}
+ onChange={(e) => setOwner(e.target.value)}
+ placeholder={isGitLab ? "my-group" : "my-org"}
+ maxLength={200}
+ autoComplete="off"
+ />
+ </div>
+
+ {/* Repository / Project */}
+ <div className="flex flex-col gap-y-2">
+ <label className="block text-sm font-medium text-control">
+ {isGitLab
+ ? t("settings.members.workload-identity-project")
+ : t("settings.members.workload-identity-repo")}
+ </label>
+ <Input
+ value={repo}
+ onChange={(e) => setRepo(e.target.value)}
+ placeholder={isGitLab ? "my-project" : "my-repo"}
+ maxLength={200}
+ autoComplete="off"
+ />
+ <span className="text-xs text-gray-500">
+ {isGitLab
+ ? t("settings.members.workload-identity-project-hint")
+ : t("settings.members.workload-identity-repo-hint")}
+ </span>
+ </div>
+
+ {/* Allowed Branches/Tags (GitLab only) */}
+ {isGitLab && (
+ <div className="flex flex-col gap-y-2">
+ <label className="block text-sm font-medium text-control">
+ {t(
+ "settings.members.workload-identity-allowed-branches-tags"
+ )}
+ </label>
+ <select
+ value={refType}
+ onChange={(e) => setRefType(e.target.value as RefType)}
+ className="border border-control-border rounded-xs text-sm px-2 py-2 bg-white"
+ >
+ <option value="all">
+ {t("settings.members.workload-identity-all-branches-tags")}
+ </option>
+ <option value="branch">
+ {t("settings.members.workload-identity-specific-branch")}
+ </option>
+ <option value="tag">
+ {t("settings.members.workload-identity-specific-tag")}
+ </option>
+ </select>
+ </div>
+ )}
+
+ {/* Branch / Tag */}
+ {showBranchField && (
+ <div className="flex flex-col gap-y-2">
+ <label className="block text-sm font-medium text-control">
+ {isTagRefType
+ ? t("settings.members.workload-identity-tag")
+ : t("settings.members.workload-identity-branch")}
+ </label>
+ <Input
+ value={branch}
+ onChange={(e) => setBranch(e.target.value)}
+ placeholder={isTagRefType ? "v1.0.0" : "main"}
+ maxLength={200}
+ autoComplete="off"
+ />
+ <span className="text-xs text-gray-500">
+ {isTagRefType
+ ? t("settings.members.workload-identity-tag-hint")
+ : t("settings.members.workload-identity-branch-hint")}
+ </span>
+ </div>
+ )}
+
+ {/* Advanced Settings */}
+ {showAdvanced && (
+ <div className="flex flex-col gap-y-6 pt-6 border-t">
+ {/* Issuer URL / GitLab URL */}
+ <div className="flex flex-col gap-y-2">
+ <label className="block text-sm font-medium text-control">
+ {isGitLab
+ ? t("settings.members.workload-identity-gitlab-url")
+ : t("settings.members.workload-identity-issuer")}
+ </label>
+ <Input
+ value={issuerUrl}
+ onChange={(e) => setIssuerUrl(e.target.value)}
+ maxLength={500}
+ autoComplete="off"
+ />
+ {isGitLab && (
+ <span className="text-xs text-gray-500">
+ {t("settings.members.workload-identity-gitlab-url-hint")}
+ </span>
+ )}
+ </div>
+
+ {/* Audience */}
+ <div className="flex flex-col gap-y-2">
+ <label className="block text-sm font-medium text-control">
+ {t("settings.members.workload-identity-audience")}
+ </label>
+ <Input
+ value={audience}
+ onChange={(e) => setAudience(e.target.value)}
+ maxLength={500}
+ autoComplete="off"
+ />
+ </div>
+
+ {/* Subject Pattern */}
+ <div className="flex flex-col gap-y-2">
+ <label className="block text-sm font-medium text-control">
+ {t("settings.members.workload-identity-subject")}
+ </label>
+ <Input
+ value={subjectPattern}
+ onChange={(e) => setSubjectPattern(e.target.value)}
+ maxLength={500}
+ autoComplete="off"
+ />
+ </div>
+ </div>
+ )}
+
+ {/* Advanced Settings Toggle */}
+ <button
+ type="button"
+ className="flex items-center gap-x-1 text-sm text-accent hover:underline w-fit"
+ onClick={() => setShowAdvanced(!showAdvanced)}
+ >
+ {t("settings.members.workload-identity-advanced")}
+ {showAdvanced ? (
+ <ChevronUp className="w-4 h-4" />
+ ) : (
+ <ChevronDown className="w-4 h-4" />
+ )}
+ </button>
+
+ {/* Roles (create mode only) */}
+ {!isEditMode &&
+ (projectEntity
+ ? hasProjectPermissionV2(
+ projectEntity,
+ "bb.projects.setIamPolicy"
+ )
+ : hasWorkspacePermissionV2("bb.workspaces.setIamPolicy")) && (
+ <div className="flex flex-col gap-y-2">
+ <label className="block text-sm font-medium text-control">
+ {t("settings.members.table.roles")}
+ </label>
+ <RoleMultiSelect
+ value={roles}
+ onChange={setRoles}
+ disabled={false}
+ />
+ </div>
+ )}
+ </div>
+ </div>
+
+ {/* Footer */}
+ <div className="flex items-center justify-end gap-x-2 px-6 py-4 border-t">
+ <Button variant="outline" onClick={onClose}>
+ {t("common.cancel")}
+ </Button>
+ <Button
+ disabled={!allowConfirm || !hasPermission || isRequesting}
+ onClick={handleSubmit}
+ >
+ {isEditMode ? t("common.update") : t("common.confirm")}
+ </Button>
+ </div>
+ </div>
+ </>
+ );
+}
diff --git a/frontend/src/react/locales/en-US.json b/frontend/src/react/locales/en-US.json
index 5ff913d0f8..8acd85835b 100644
--- a/frontend/src/react/locales/en-US.json
+++ b/frontend/src/react/locales/en-US.json
@@ -158,7 +158,9 @@
"view": "View",
"view-details": "View Details",
"warning": "Warning",
- "you": "you"
+ "you": "you",
+ "database-group": "Database Group",
+ "databases": "Databases"
},
"create-db": {
"cluster": "Cluster",
@@ -248,7 +250,8 @@
"mixed-label-values-warning": "Some of the selected resources have mixed values for the same key. Only edit these key-value pairs if you intend to change them.",
"unassign": "Unassign",
"unassign-alert-description": "The selected databases will be removed from the project",
- "unassign-alert-title": "Unassign databases"
+ "unassign-alert-title": "Unassign databases",
+ "select": "Select database"
},
"db": {
"character-set": "Character set",
@@ -1056,5 +1059,43 @@
},
"two-factor": {
"enabled": "2FA Enabled"
+ },
+ "database-group": {
+ "select": "Select database group"
+ },
+ "gitops": {
+ "checklist": {
+ "database-group-recommendation": "For databases sharing the same schema, a database group lets you migrate them together in one change. Define the group once and reuse it across migrations without picking individual databases every time.",
+ "external-url": "External URL",
+ "target-databases": "Target Databases",
+ "title": "Checks before we start",
+ "wif-notice-suffix": "to set up GitOps using a service account.",
+ "wif-notice-text": "Workload Identity Federation is currently supported for GitHub and GitLab only. For other VCS, refer to the tutorials for",
+ "workload-identity": "Workload Identity"
+ },
+ "documentation": "View Documentation",
+ "overview": {
+ "description": "Bytebase GitOps lets you manage Database as Code by integrating database schema changes into your CI/CD pipeline.",
+ "description-git": "Your database schema lives in Git alongside your application code. Pull requests trigger SQL review, and merging to the target branch automatically creates rollouts.",
+ "title": "What is GitOps"
+ },
+ "test-setup": {
+ "description": "Verify the workflow is working end-to-end with a sample migration file.",
+ "naming-convention": "Migration files are applied in lexicographic order. Use a timestamp or sequence prefix, e.g. 20240101000000_create_table.sql. Append _ddl or _dml to indicate the change type.",
+ "step-create-branch": "Create a new branch, add the file above, and open a pull request targeting {branch}.",
+ "step-merge": "Once the review passes, merge the PR. Bytebase will automatically create a rollout and deploy to the target environments.",
+ "step-sql-review": "SQL Review runs automatically on the pull request and posts review comments.",
+ "title": "Test your first GitOps migration"
+ },
+ "workflow": {
+ "description": "Copy the workflow files into your repository to automate SQL review and database rollouts.",
+ "file-hint": "Save as {filePath} in your repository {repository}",
+ "provider-not-match": "The selected workload identity only works for {provider}.",
+ "self-hosted-runner": "Self-hosted runner",
+ "title": "Workflow file generation"
+ },
+ "workload-identity": {
+ "select-placeholder": "Select a workload identity"
+ }
}
}
diff --git a/frontend/src/react/locales/es-ES.json b/frontend/src/react/locales/es-ES.json
index 311c7d39d6..31a15a53d3 100644
--- a/frontend/src/react/locales/es-ES.json
+++ b/frontend/src/react/locales/es-ES.json
@@ -158,7 +158,9 @@
"view": "Ver",
"view-details": "Ver Detalles",
"warning": "Advertencia",
- "you": "tu"
+ "you": "tu",
+ "database-group": "Grupo de bases de datos",
+ "databases": "Bases de datos"
},
"create-db": {
"cluster": "Clúster",
@@ -248,7 +250,8 @@
"mixed-label-values-warning": "Algunos de los recursos seleccionados tienen valores mixtos para la misma clave. Solo edite estos pares clave-valor si tiene la intención de cambiarlos.",
"unassign": "Desasignar",
"unassign-alert-description": "Las bases de datos seleccionadas serán eliminadas del proyecto",
- "unassign-alert-title": "Desasignar bases de datos"
+ "unassign-alert-title": "Desasignar bases de datos",
+ "select": "Seleccionar base de datos"
},
"db": {
"character-set": "Juego de caracteres",
@@ -1056,5 +1059,43 @@
},
"two-factor": {
"enabled": "2FA habilitado"
+ },
+ "database-group": {
+ "select": "Seleccionar grupo de bases de datos"
+ },
+ "gitops": {
+ "checklist": {
+ "database-group-recommendation": "Para bases de datos con el mismo esquema, un grupo de bases de datos permite migrarlas juntas en un solo cambio. Defina el grupo una vez y reutilícelo en las migraciones sin tener que seleccionar bases de datos individuales cada vez.",
+ "external-url": "URL externa",
+ "target-databases": "Bases de datos de destino",
+ "title": "Verificaciones antes de comenzar",
+ "wif-notice-suffix": "para configurar GitOps con una cuenta de servicio.",
+ "wif-notice-text": "Workload Identity Federation actualmente solo es compatible con GitHub y GitLab. Para otros VCS, consulte los tutoriales de",
+ "workload-identity": "Identidad de carga de trabajo"
+ },
+ "documentation": "Ver documentación",
+ "overview": {
+ "description": "Bytebase GitOps le permite gestionar Database as Code integrando los cambios de esquema de base de datos en su pipeline de CI/CD.",
+ "description-git": "El esquema de su base de datos se almacena en Git junto con el código de su aplicación. Las pull requests activan la revisión de SQL, y la fusión en la rama de destino crea automáticamente los despliegues.",
+ "title": "Qué es GitOps"
+ },
+ "test-setup": {
+ "description": "Verifique que el flujo de trabajo funciona de extremo a extremo con un archivo de migración de ejemplo.",
+ "naming-convention": "Los archivos de migración se aplican en orden lexicográfico. Use un prefijo de marca de tiempo o secuencia, p. ej. 20240101000000_create_table.sql. Agregue _ddl o _dml para indicar el tipo de cambio.",
+ "step-create-branch": "Cree una nueva rama, agregue el archivo anterior y abra una pull request dirigida a {branch}.",
+ "step-merge": "Una vez que la revisión pase, fusione el PR. Bytebase creará automáticamente un despliegue y lo implementará en los entornos de destino.",
+ "step-sql-review": "SQL Review se ejecuta automáticamente en la pull request y publica comentarios de revisión.",
+ "title": "Pruebe su primera migración GitOps"
+ },
+ "workflow": {
+ "description": "Copie los archivos de flujo de trabajo en su repositorio para automatizar la revisión de SQL y los despliegues de base de datos.",
+ "file-hint": "Guardar como {filePath} en su repositorio",
+ "provider-not-match": "La workload identity seleccionada solo funciona para {provider}.",
+ "self-hosted-runner": "Runner self-hosted",
+ "title": "Generación de archivo de flujo de trabajo"
+ },
+ "workload-identity": {
+ "select-placeholder": "Seleccionar una identidad de carga de trabajo"
+ }
}
}
diff --git a/frontend/src/react/locales/ja-JP.json b/frontend/src/react/locales/ja-JP.json
index 47f7642cfa..c0e58d0ea3 100644
--- a/frontend/src/react/locales/ja-JP.json
+++ b/frontend/src/react/locales/ja-JP.json
@@ -158,7 +158,9 @@
"view": "表示",
"view-details": "詳細を表示",
"warning": "警告する",
- "you": "あなた"
+ "you": "あなた",
+ "database-group": "データベースグループ",
+ "databases": "データベース"
},
"create-db": {
"cluster": "集まる",
@@ -248,7 +250,8 @@
"mixed-label-values-warning": "選択されたリソースの一部は、同じキーに対して異なる値を持っています。これらのキーと値のペアを変更する場合にのみ編集してください。",
"unassign": "割り当てを解除する",
"unassign-alert-description": "選択したデータベースがプロジェクトから削除されます",
- "unassign-alert-title": "データベースの割り当てを解除する"
+ "unassign-alert-title": "データベースの割り当てを解除する",
+ "select": "データベースの選択"
},
"db": {
"character-set": "文字セット",
@@ -1056,5 +1059,43 @@
},
"two-factor": {
"enabled": "二要素認証がオンになっています"
+ },
+ "database-group": {
+ "select": "データベースグループを選択"
+ },
+ "gitops": {
+ "checklist": {
+ "database-group-recommendation": "同じスキーマを持つデータベースには、データベースグループを使用すると一度の変更でまとめてマイグレーションできます。グループを一度定義すれば、毎回個別にデータベースを選択することなく、マイグレーション全体で再利用できます。",
+ "external-url": "外部URL",
+ "target-databases": "ターゲットデータベース",
+ "title": "開始前の確認",
+ "wif-notice-suffix": "サービスアカウントを使用して GitOps を設定できます。",
+ "wif-notice-text": "Workload Identity Federation は現在 GitHub と GitLab のみサポートしています。他の VCS については、チュートリアルを参照してください:",
+ "workload-identity": "ワークロードアイデンティティ"
+ },
+ "documentation": "ドキュメントを見る",
+ "overview": {
+ "description": "Bytebase GitOps は、データベーススキーマの変更を CI/CD パイプラインに統合し、Database as Code として管理できます。",
+ "description-git": "データベーススキーマはアプリケーションコードと一緒に Git で管理されます。プルリクエストで SQL レビューがトリガーされ、ターゲットブランチへのマージで自動的にロールアウトが作成されます。",
+ "title": "GitOps とは"
+ },
+ "test-setup": {
+ "description": "サンプルマイグレーションファイルでワークフロー全体が正常に動作するか確認します。",
+ "naming-convention": "マイグレーションファイルは辞書順に適用されます。タイムスタンプまたはシーケンス番号のプレフィックスを使用してください(例: 20240101000000_create_table.sql)。変更タイプを示すために _ddl または _dml を末尾に追加してください。",
+ "step-create-branch": "新しいブランチを作成し、上記のファイルを追加して、{branch} へのプルリクエストを作成します。",
+ "step-merge": "レビューが通過したら PR をマージします。Bytebase が自動的にロールアウトを作成し、ターゲット環境にデプロイします。",
+ "step-sql-review": "SQL Review がプルリクエストで自動的に実行され、レビューコメントが投稿されます。",
+ "title": "最初の GitOps マイグレーションをテスト"
+ },
+ "workflow": {
+ "description": "ワークフローファイルをリポジトリにコピーして、SQL レビューとデータベースロールアウトを自動化します。",
+ "file-hint": "リポジトリ内に {filePath} として保存",
+ "provider-not-match": "選択された ワークロード アイデンティティ は {provider} 専用です。",
+ "self-hosted-runner": "セルフホスト runner",
+ "title": "ワークフローファイル生成"
+ },
+ "workload-identity": {
+ "select-placeholder": "ワークロードアイデンティティを選択"
+ }
}
}
diff --git a/frontend/src/react/locales/vi-VN.json b/frontend/src/react/locales/vi-VN.json
index ec0e200c1f..b54e7b350d 100644
--- a/frontend/src/react/locales/vi-VN.json
+++ b/frontend/src/react/locales/vi-VN.json
@@ -158,7 +158,9 @@
"view": "Xem",
"view-details": "Xem Chi tiết",
"warning": "Cảnh báo",
- "you": "bạn"
+ "you": "bạn",
+ "database-group": "Nhóm cơ sở dữ liệu",
+ "databases": "Cơ sở dữ liệu"
},
"create-db": {
"cluster": "Cụm",
@@ -248,7 +250,8 @@
"mixed-label-values-warning": "Một số tài nguyên đã chọn có các giá trị khác nhau cho cùng một khóa. Chỉ chỉnh sửa các cặp khóa-giá trị này nếu bạn muốn thay đổi chúng.",
"unassign": "Hủy gán",
"unassign-alert-description": "Các cơ sở dữ liệu đã chọn sẽ bị xóa khỏi dự án",
- "unassign-alert-title": "Hủy gán cơ sở dữ liệu"
+ "unassign-alert-title": "Hủy gán cơ sở dữ liệu",
+ "select": "Chọn cơ sở dữ liệu"
},
"db": {
"character-set": "Bộ ký tự",
@@ -1056,5 +1059,43 @@
},
"two-factor": {
"enabled": "Đã bật 2FA"
+ },
+ "database-group": {
+ "select": "Chọn nhóm cơ sở dữ liệu"
+ },
+ "gitops": {
+ "checklist": {
+ "database-group-recommendation": "Đối với các cơ sở dữ liệu có cùng schema, nhóm cơ sở dữ liệu cho phép bạn migration tất cả cùng lúc trong một thay đổi. Chỉ cần định nghĩa nhóm một lần và tái sử dụng trong các lần migration mà không cần chọn từng cơ sở dữ liệu mỗi lần.",
+ "external-url": "URL bên ngoài",
+ "target-databases": "Cơ sở dữ liệu đích",
+ "title": "Kiểm tra trước khi bắt đầu",
+ "wif-notice-suffix": "để thiết lập GitOps bằng tài khoản dịch vụ.",
+ "wif-notice-text": "Workload Identity Federation hiện chỉ hỗ trợ GitHub và GitLab. Đối với các VCS khác, vui lòng tham khảo hướng dẫn cho",
+ "workload-identity": "Workload Identity"
+ },
+ "documentation": "Xem tài liệu",
+ "overview": {
+ "description": "Bytebase GitOps cho phép bạn quản lý Database as Code bằng cách tích hợp các thay đổi schema cơ sở dữ liệu vào pipeline CI/CD.",
+ "description-git": "Schema cơ sở dữ liệu của bạn được lưu trữ trong Git cùng với mã nguồn ứng dụng. Pull request sẽ kích hoạt SQL review, và việc merge vào nhánh đích sẽ tự động tạo rollout.",
+ "title": "GitOps là gì"
+ },
+ "test-setup": {
+ "description": "Xác minh workflow hoạt động đầy đủ với một tệp migration mẫu.",
+ "naming-convention": "Các tệp migration được áp dụng theo thứ tự từ điển. Sử dụng tiền tố timestamp hoặc số thứ tự, ví dụ: 20240101000000_create_table.sql. Thêm _ddl hoặc _dml để chỉ loại thay đổi.",
+ "step-create-branch": "Tạo nhánh mới, thêm tệp ở trên và mở pull request nhắm đến {branch}.",
+ "step-merge": "Sau khi review thông qua, merge PR. Bytebase sẽ tự động tạo rollout và triển khai đến các môi trường đích.",
+ "step-sql-review": "SQL Review tự động chạy trên pull request và đăng nhận xét review.",
+ "title": "Thử nghiệm migration GitOps đầu tiên"
+ },
+ "workflow": {
+ "description": "Sao chép các tệp workflow vào kho lưu trữ của bạn để tự động hóa SQL review và triển khai cơ sở dữ liệu.",
+ "file-hint": "Lưu dưới dạng {filePath} trong kho lưu trữ của bạn",
+ "provider-not-match": "Workload identity đã chọn chỉ hoạt động cho {provider}.",
+ "self-hosted-runner": "Runner tự lưu trữ",
+ "title": "Tạo tệp workflow"
+ },
+ "workload-identity": {
+ "select-placeholder": "Chọn một workload identity"
+ }
}
}
diff --git a/frontend/src/react/locales/zh-CN.json b/frontend/src/react/locales/zh-CN.json
index 64b169b224..5499c5bd01 100644
--- a/frontend/src/react/locales/zh-CN.json
+++ b/frontend/src/react/locales/zh-CN.json
@@ -158,7 +158,9 @@
"view": "查看",
"view-details": "查看详情",
"warning": "警告",
- "you": "您"
+ "you": "您",
+ "database-group": "数据库分组",
+ "databases": "数据库"
},
"create-db": {
"cluster": "集群",
@@ -248,7 +250,8 @@
"mixed-label-values-warning": "部分标签拥有不同的值,编辑标签将会批量应用。仅在您打算更改时再编辑这些键值对。",
"unassign": "取消分配",
"unassign-alert-description": "选定的数据库将从项目中移除",
- "unassign-alert-title": "取消分配数据库"
+ "unassign-alert-title": "取消分配数据库",
+ "select": "选择数据库"
},
"db": {
"character-set": "字符集",
@@ -1056,5 +1059,43 @@
},
"two-factor": {
"enabled": "双重认证已开启"
+ },
+ "database-group": {
+ "select": "选择数据库分组"
+ },
+ "gitops": {
+ "checklist": {
+ "database-group-recommendation": "对于具有相同 Schema 的数据库,数据库分组可以让您在一次变更中同时迁移它们。只需定义一次分组,即可在多次迁移中复用,无需每次都逐个选择数据库。",
+ "external-url": "外部访问地址",
+ "target-databases": "目标数据库",
+ "title": "开始前检查",
+ "wif-notice-suffix": "以使用服务账号配置 GitOps。",
+ "wif-notice-text": "Workload Identity Federation 目前仅支持 GitHub 和 GitLab。对于其他 VCS,请参考以下教程:",
+ "workload-identity": "工作负载身份"
+ },
+ "documentation": "查看文档",
+ "overview": {
+ "description": "Bytebase GitOps 让您通过将数据库架构变更集成到 CI/CD 流水线中,以 Database as Code 的方式管理数据库。",
+ "description-git": "数据库架构与应用代码一起存储在 Git 中。拉取请求会触发 SQL 审查,合并到目标分支后会自动创建变更发布。",
+ "title": "什么是 GitOps"
+ },
+ "test-setup": {
+ "description": "使用示例迁移文件验证整个工作流是否正常运行。",
+ "naming-convention": "迁移文件按字典顺序执行。请使用时间戳或序号前缀,例如 20240101000000_create_table.sql。在文件名末尾添加 _ddl 或 _dml 来标识变更类型。",
+ "step-create-branch": "创建新分支,添加上面的文件,然后向 {branch} 提交拉取请求。",
+ "step-merge": "审查通过后,合并 PR。Bytebase 将自动创建 rollout 并部署到目标环境。",
+ "step-sql-review": "SQL Review 会自动在拉取请求上运行并发布审查评论。",
+ "title": "测试您的首次 GitOps 迁移"
+ },
+ "workflow": {
+ "description": "将工作流文件复制到您的代码仓库中,以自动化 SQL 审查和数据库变更发布。",
+ "file-hint": "保存为仓库中的 {filePath}",
+ "provider-not-match": "所选的 工作负载标识 (Workload Identity) 仅适用于 {provider}。",
+ "self-hosted-runner": "自托管 runner",
+ "title": "工作流文件生成"
+ },
+ "workload-identity": {
+ "select-placeholder": "选择工作负载身份"
+ }
}
}
diff --git a/frontend/src/react/pages/project/ProjectGitOpsPage.tsx b/frontend/src/react/pages/project/ProjectGitOpsPage.tsx
new file mode 100644
index 0000000000..5bb9a3cc61
--- /dev/null
+++ b/frontend/src/react/pages/project/ProjectGitOpsPage.tsx
@@ -0,0 +1,1086 @@
+import { Check, ChevronDown, ChevronRight, Copy, XCircle } from "lucide-react";
+import { useCallback, useEffect, useMemo, useState } from "react";
+import { useTranslation } from "react-i18next";
+import gitopsWorkflowImage from "@/assets/gitops-workflow.svg";
+import { CreateWorkloadIdentityDrawer } from "@/react/components/CreateWorkloadIdentityDrawer";
+import { Alert } from "@/react/components/ui/alert";
+import { Button } from "@/react/components/ui/button";
+import { Combobox, type ComboboxOption } from "@/react/components/ui/combobox";
+import { Switch } from "@/react/components/ui/switch";
+import {
+ Tabs,
+ TabsList,
+ TabsPanel,
+ TabsTrigger,
+} from "@/react/components/ui/tabs";
+import { Tooltip } from "@/react/components/ui/tooltip";
+import { useVueState } from "@/react/hooks/useVueState";
+import { cn } from "@/react/lib/utils";
+import { router } from "@/router";
+import { SETTING_ROUTE_WORKSPACE_GENERAL } from "@/router/dashboard/workspaceSetting";
+import {
+ extractWorkloadIdentityId,
+ useActuatorV1Store,
+ useDatabaseV1Store,
+ useProjectV1Store,
+} from "@/store";
+import { useDBGroupStore } from "@/store/modules/dbGroup";
+import { projectNamePrefix } from "@/store/modules/v1/common";
+import { useWorkloadIdentityStore } from "@/store/modules/workloadIdentity";
+import { DatabaseGroupView } from "@/types/proto-es/v1/database_group_service_pb";
+import type { WorkloadIdentity } from "@/types/proto-es/v1/workload_identity_service_pb";
+import { WorkloadIdentityConfig_ProviderType } from "@/types/proto-es/v1/workload_identity_service_pb";
+import {
+ extractDatabaseResourceName,
+ getWorkloadIdentityProviderText,
+ hasProjectPermissionV2,
+ hasWorkspacePermissionV2,
+ parseWorkloadIdentitySubjectPattern,
+} from "@/utils";
+
+export function ProjectGitOpsPage({ projectId }: { projectId: string }) {
+ const { t } = useTranslation();
+ const actuatorStore = useActuatorV1Store();
+ const workloadIdentityStore = useWorkloadIdentityStore();
+ const dbGroupStore = useDBGroupStore();
+ const databaseStore = useDatabaseV1Store();
+ const projectStore = useProjectV1Store();
+
+ const projectName = `${projectNamePrefix}${projectId}`;
+ const project = useVueState(() => projectStore.getProjectByName(projectName));
+
+ const [showCreateDrawer, setShowCreateDrawer] = useState(false);
+ const [selectedIdentityName, setSelectedIdentityName] = useState("");
+ const [selectedDatabaseNames, setSelectedDatabaseNames] = useState<string[]>(
+ []
+ );
+ const [selectedDatabaseGroupName, setSelectedDatabaseGroupName] =
+ useState("");
+ const [targetTab, setTargetTab] = useState<"GROUP" | "DATABASE">("GROUP");
+ const [activeTab, setActiveTab] = useState("github");
+ const [useSelfhostRunner, setUseSelfhostRunner] = useState(false);
+ const [showSqlReviewYaml, setShowSqlReviewYaml] = useState(true);
+ const [showReleaseYaml, setShowReleaseYaml] = useState(true);
+ const [showGitlabCiYaml, setShowGitlabCiYaml] = useState(true);
+
+ // Workload identity options
+ const [wiOptions, setWiOptions] = useState<ComboboxOption[]>([]);
+ const [wiSearch, setWiSearch] = useState("");
+
+ const fetchWorkloadIdentities = useCallback(
+ async (search: string) => {
+ const all: ComboboxOption[] = [];
+ let pageToken: string | undefined;
+ // Fetch all pages so every identity is discoverable.
+ do {
+ const resp = await workloadIdentityStore.listWorkloadIdentities({
+ parent: projectName,
+ filter: { query: search },
+ pageToken,
+ pageSize: 1000,
+ showDeleted: false,
+ });
+ for (const wi of resp.workloadIdentities) {
+ all.push({
+ value: wi.name,
+ label: wi.title || wi.email,
+ description: wi.email,
+ });
+ }
+ pageToken = resp.nextPageToken || undefined;
+ } while (pageToken);
+ setWiOptions(all);
+ },
+ [projectName, workloadIdentityStore]
+ );
+
+ useEffect(() => {
+ fetchWorkloadIdentities(wiSearch).catch(() => {});
+ }, [wiSearch, fetchWorkloadIdentities]);
+
+ // Database group options
+ const [dbGroupOptions, setDbGroupOptions] = useState<ComboboxOption[]>([]);
+ useEffect(() => {
+ dbGroupStore
+ .fetchDBGroupListByProjectName(projectName, DatabaseGroupView.BASIC)
+ .then((groups) => {
+ setDbGroupOptions(
+ groups.map((g) => ({
+ value: g.name,
+ label: g.title || g.name,
+ }))
+ );
+ })
+ .catch(() => {});
+ }, [projectName, dbGroupStore]);
+
+ // Database options for individual selection
+ const [dbOptions, setDbOptions] = useState<ComboboxOption[]>([]);
+ const [dbSearch, setDbSearch] = useState("");
+ useEffect(() => {
+ const fetchAllDatabases = async () => {
+ const all: ComboboxOption[] = [];
+ let pageToken: string | undefined;
+ do {
+ const resp = await databaseStore.fetchDatabases({
+ parent: projectName,
+ filter: dbSearch ? { query: dbSearch } : {},
+ pageSize: 1000,
+ pageToken,
+ });
+ for (const db of resp.databases) {
+ all.push({
+ value: db.name,
+ label: extractDatabaseResourceName(db.name).databaseName,
+ description: db.name,
+ });
+ }
+ pageToken = resp.nextPageToken || undefined;
+ } while (pageToken);
+ setDbOptions(all);
+ };
+ fetchAllDatabases().catch(() => {});
+ }, [projectName, dbSearch, databaseStore]);
+
+ // Fetch the selected identity into the store cache so getWorkloadIdentity
+ // returns the real object (with workloadIdentityConfig) instead of a stub.
+ useEffect(() => {
+ if (selectedIdentityName) {
+ workloadIdentityStore
+ .getOrFetchWorkloadIdentity(selectedIdentityName)
+ .catch(() => {});
+ }
+ }, [selectedIdentityName, workloadIdentityStore]);
+
+ const selectedIdentity = useVueState(() => {
+ if (!selectedIdentityName) return undefined;
+ return workloadIdentityStore.getWorkloadIdentity(selectedIdentityName);
+ });
+
+ const selectedConfig = selectedIdentity?.workloadIdentityConfig;
+
+ // Sync active tab with selected identity provider
+ useEffect(() => {
+ if (
+ selectedConfig?.providerType ===
+ WorkloadIdentityConfig_ProviderType.GITLAB
+ ) {
+ setActiveTab("gitlab");
+ } else if (
+ selectedConfig?.providerType ===
+ WorkloadIdentityConfig_ProviderType.GITHUB
+ ) {
+ setActiveTab("github");
+ }
+ }, [selectedConfig?.providerType]);
+
+ const parsedSubject = useMemo(() => {
+ if (!selectedIdentity) return undefined;
+ return parseWorkloadIdentitySubjectPattern(selectedIdentity);
+ }, [selectedIdentity]);
+
+ const repoUrl = useMemo(() => {
+ const parsed = parsedSubject;
+ if (!parsed?.owner || !parsed.repo) return "";
+ const providerType = selectedConfig?.providerType;
+ if (providerType === WorkloadIdentityConfig_ProviderType.GITHUB) {
+ return `https://github.com/${parsed.owner}/${parsed.repo}`;
+ }
+ if (providerType === WorkloadIdentityConfig_ProviderType.GITLAB) {
+ const issuer = selectedConfig?.issuerUrl ?? "https://gitlab.com";
+ const base = issuer.replace(/\/$/, "");
+ return `${base}/${parsed.owner}/${parsed.repo}`;
+ }
+ return "";
+ }, [parsedSubject, selectedConfig]);
+
+ const branch = parsedSubject?.branch || "main";
+
+ const bytebaseUrl = useVueState(() =>
+ (actuatorStore.serverInfo?.externalUrl ?? "").replace(/\/$/, "")
+ );
+
+ const workloadIdentityEmail = selectedIdentityName
+ ? extractWorkloadIdentityId(selectedIdentityName)
+ : "{WORKLOAD_IDENTITY_EMAIL}";
+
+ const hasTargetSelected =
+ targetTab === "GROUP"
+ ? !!selectedDatabaseGroupName
+ : selectedDatabaseNames.length > 0;
+
+ const targetsString = useMemo(() => {
+ if (targetTab === "GROUP" && selectedDatabaseGroupName) {
+ return selectedDatabaseGroupName;
+ }
+ if (selectedDatabaseNames.length === 0) return "";
+ return selectedDatabaseNames.join(",");
+ }, [targetTab, selectedDatabaseGroupName, selectedDatabaseNames]);
+
+ const targetsPlaceholder =
+ targetsString || "instances/{instance}/databases/{database}";
+ const runsOn = useSelfhostRunner ? "self-hosted" : "ubuntu-latest";
+
+ const handleTargetTabChange = (tab: "GROUP" | "DATABASE") => {
+ setTargetTab(tab);
+ if (tab === "GROUP") {
+ setSelectedDatabaseNames([]);
+ } else {
+ setSelectedDatabaseGroupName("");
+ }
+ };
+
+ const handleWorkloadIdentityCreated = (wi: WorkloadIdentity) => {
+ setSelectedIdentityName(wi.name);
+ fetchWorkloadIdentities("");
+ };
+
+ const canCreateWorkloadIdentity = project
+ ? hasProjectPermissionV2(project, "bb.workloadIdentities.create")
+ : false;
+
+ // --- YAML generation ---
+ const githubSqlReviewYaml = useMemo(
+ () =>
+ generateGithubSqlReviewYaml({
+ branch,
+ runsOn,
+ bytebaseUrl,
+ workloadIdentityEmail,
+ projectId,
+ targetsPlaceholder,
+ }),
+ [
+ branch,
+ runsOn,
+ bytebaseUrl,
+ workloadIdentityEmail,
+ projectId,
+ targetsPlaceholder,
+ ]
+ );
+
+ const githubReleaseYaml = useMemo(
+ () =>
+ generateGithubReleaseYaml({
+ branch,
+ runsOn,
+ bytebaseUrl,
+ workloadIdentityEmail,
+ projectId,
+ targetsPlaceholder,
+ }),
+ [
+ branch,
+ runsOn,
+ bytebaseUrl,
+ workloadIdentityEmail,
+ projectId,
+ targetsPlaceholder,
+ ]
+ );
+
+ const gitlabCiYaml = useMemo(
+ () =>
+ generateGitlabCiYaml({
+ branch,
+ bytebaseUrl,
+ workloadIdentityEmail,
+ projectId,
+ targetsPlaceholder,
+ }),
+ [branch, bytebaseUrl, workloadIdentityEmail, projectId, targetsPlaceholder]
+ );
+
+ const providerMismatchGithub =
+ selectedConfig &&
+ activeTab === "github" &&
+ selectedConfig.providerType !== WorkloadIdentityConfig_ProviderType.GITHUB;
+ const providerMismatchGitlab =
+ selectedConfig &&
+ activeTab === "gitlab" &&
+ selectedConfig.providerType !== WorkloadIdentityConfig_ProviderType.GITLAB;
+
+ return (
+ <div className="w-full px-4 flex flex-col gap-y-1 py-4">
+ {/* Section 1: What is GitOps */}
+ <div className="border border-gray-200 rounded p-6 flex flex-col gap-y-3">
+ <div className="flex flex-col gap-y-1">
+ <h2 className="text-lg font-medium">{t("gitops.overview.title")}</h2>
+ <p className="textinfolabel">{t("gitops.overview.description")}</p>
+ <p className="textinfolabel">
+ {t("gitops.overview.description-git")}
+ </p>
+ </div>
+ <img
+ src={gitopsWorkflowImage}
+ alt="GitOps Workflow"
+ className="w-full max-w-4xl object-contain my-2"
+ />
+ <div>
+ <a
+ href="https://docs.bytebase.com/gitops/overview?source=console"
+ target="_blank"
+ rel="noreferrer"
+ className="text-accent hover:underline"
+ >
+ {t("gitops.documentation")} {"\u2192"}
+ </a>
+ </div>
+ </div>
+
+ <span className="mx-auto w-0.5 h-8 bg-block-border" aria-hidden="true" />
+
+ {/* Section 2: Checks before we start */}
+ <div className="border border-gray-200 rounded p-6 flex flex-col gap-y-3">
+ <h2 className="text-lg font-medium">{t("gitops.checklist.title")}</h2>
+
+ <Alert variant="info">
+ <span>
+ {t("gitops.checklist.wif-notice-text")}{" "}
+ <a
+ href="https://docs.bytebase.com/tutorials/gitops-bitbucket-workflow?source=console"
+ target="_blank"
+ rel="noreferrer"
+ className="text-accent hover:underline"
+ >
+ Bitbucket
+ </a>{" "}
+ /{" "}
+ <a
+ href="https://docs.bytebase.com/tutorials/gitops-azure-devops-workflow?source=console"
+ target="_blank"
+ rel="noreferrer"
+ className="text-accent hover:underline"
+ >
+ Azure DevOps
+ </a>{" "}
+ {t("gitops.checklist.wif-notice-suffix")}
+ </span>
+ </Alert>
+
+ {/* Check 1: External URL */}
+ <div className="flex items-start gap-x-3 py-3">
+ <CheckOrX ok={!!bytebaseUrl} />
+ <div className="flex flex-col flex-1 gap-y-1">
+ <span className="text-sm font-medium">
+ {t("gitops.checklist.external-url")}
+ </span>
+ {bytebaseUrl ? (
+ <span className="text-sm text-control-light">{bytebaseUrl}</span>
+ ) : (
+ <MissingExternalURLAttention />
+ )}
+ </div>
+ </div>
+
+ {/* Check 2: Workload Identity */}
+ <div className="flex items-start gap-x-3 py-3">
+ <CheckOrX ok={!!selectedIdentityName} />
+ <div className="flex flex-col gap-y-2 flex-1">
+ <span className="text-sm font-medium">
+ {t("gitops.checklist.workload-identity")}
+ </span>
+ <div className="flex items-center gap-x-3">
+ <Combobox
+ value={selectedIdentityName}
+ options={wiOptions}
+ placeholder={t("gitops.workload-identity.select-placeholder")}
+ onChange={setSelectedIdentityName}
+ onSearch={setWiSearch}
+ className="max-w-lg"
+ />
+ <Tooltip
+ content={
+ canCreateWorkloadIdentity
+ ? undefined
+ : t("common.missing-required-permission", {
+ permissions: "bb.workloadIdentities.create",
+ })
+ }
+ >
+ <Button
+ variant="outline"
+ disabled={!canCreateWorkloadIdentity}
+ onClick={() => setShowCreateDrawer(true)}
+ >
+ {t("common.create")}
+ </Button>
+ </Tooltip>
+ </div>
+ {repoUrl && (
+ <a
+ href={repoUrl}
+ target="_blank"
+ rel="noreferrer"
+ className="text-sm text-accent hover:underline"
+ >
+ {repoUrl} {"\u2192"}
+ </a>
+ )}
+ </div>
+ </div>
+
+ {/* Check 3: Target Databases */}
+ <div className="flex items-start gap-x-3 py-3">
+ <CheckOrX ok={hasTargetSelected} />
+ <div className="flex flex-col gap-y-2 flex-1">
+ <span className="text-sm font-medium">
+ {t("gitops.checklist.target-databases")}
+ </span>
+ <div className="flex gap-x-0">
+ <Button
+ variant={targetTab === "GROUP" ? "default" : "outline"}
+ size="sm"
+ className="rounded-r-none"
+ onClick={() => handleTargetTabChange("GROUP")}
+ >
+ {t("common.database-group")}
+ </Button>
+ <Button
+ variant={targetTab === "DATABASE" ? "default" : "outline"}
+ size="sm"
+ className="rounded-l-none"
+ onClick={() => handleTargetTabChange("DATABASE")}
+ >
+ {t("common.databases")}
+ </Button>
+ </div>
+ <div className="max-w-lg">
+ {targetTab === "GROUP" ? (
+ <>
+ <Combobox
+ value={selectedDatabaseGroupName}
+ options={dbGroupOptions}
+ placeholder={t("database-group.select")}
+ onChange={setSelectedDatabaseGroupName}
+ />
+ <p className="text-xs text-control-light mt-1">
+ {t("gitops.checklist.database-group-recommendation")}
+ </p>
+ </>
+ ) : (
+ <MultiDatabaseSelect
+ value={selectedDatabaseNames}
+ options={dbOptions}
+ onChange={setSelectedDatabaseNames}
+ onSearch={setDbSearch}
+ />
+ )}
+ </div>
+ {targetsString && (
+ <p className="text-sm text-control-light">
+ <span className="font-medium">targets:</span>{" "}
+ <code className="text-xs bg-gray-100 px-1 py-0.5 rounded">
+ {targetsString}
+ </code>
+ </p>
+ )}
+ </div>
+ </div>
+ </div>
+
+ <span className="mx-auto w-0.5 h-8 bg-block-border" aria-hidden="true" />
+
+ {/* Section 3: Workflow file generation */}
+ <div className="border border-gray-200 rounded p-6 flex flex-col gap-y-3">
+ <div className="flex flex-col gap-y-1">
+ <h2 className="text-lg font-medium">{t("gitops.workflow.title")}</h2>
+ <p className="text-sm text-control-light">
+ {t("gitops.workflow.description")}
+ </p>
+ </div>
+
+ <Tabs value={activeTab} onValueChange={setActiveTab}>
+ <TabsList>
+ <TabsTrigger value="github" className="w-[140px] justify-center">
+ GitHub Actions
+ </TabsTrigger>
+ <TabsTrigger value="gitlab" className="w-[140px] justify-center">
+ GitLab CI
+ </TabsTrigger>
+ </TabsList>
+
+ <TabsPanel value="github">
+ {providerMismatchGithub && (
+ <Alert variant="error" className="mb-3">
+ {t("gitops.workflow.provider-not-match", {
+ provider: getWorkloadIdentityProviderText(
+ selectedConfig!.providerType
+ ),
+ })}
+ </Alert>
+ )}
+ <div className="flex items-center gap-x-2 my-3">
+ <span className="text-sm">
+ {t("gitops.workflow.self-hosted-runner")}
+ </span>
+ <Switch
+ checked={useSelfhostRunner}
+ onCheckedChange={setUseSelfhostRunner}
+ />
+ </div>
+
+ <CollapsibleCode
+ label={
+ <FileHintLabel
+ filePath=".github/workflows/sql-review.yml"
+ repository={parsedSubject?.repo}
+ />
+ }
+ code={githubSqlReviewYaml}
+ open={showSqlReviewYaml}
+ onToggle={() => setShowSqlReviewYaml(!showSqlReviewYaml)}
+ />
+
+ <CollapsibleCode
+ label={
+ <FileHintLabel
+ filePath=".github/workflows/release.yml"
+ repository={parsedSubject?.repo}
+ />
+ }
+ code={githubReleaseYaml}
+ open={showReleaseYaml}
+ onToggle={() => setShowReleaseYaml(!showReleaseYaml)}
+ className="mt-4"
+ />
+ </TabsPanel>
+
+ <TabsPanel value="gitlab">
+ {providerMismatchGitlab && (
+ <Alert variant="error" className="mb-3">
+ {t("gitops.workflow.provider-not-match", {
+ provider: getWorkloadIdentityProviderText(
+ selectedConfig!.providerType
+ ),
+ })}
+ </Alert>
+ )}
+ <CollapsibleCode
+ label={
+ <FileHintLabel
+ filePath=".gitlab-ci.yml"
+ repository={parsedSubject?.repo}
+ />
+ }
+ code={gitlabCiYaml}
+ open={showGitlabCiYaml}
+ onToggle={() => setShowGitlabCiYaml(!showGitlabCiYaml)}
+ />
+ </TabsPanel>
+ </Tabs>
+ </div>
+
+ <span className="mx-auto w-0.5 h-8 bg-block-border" aria-hidden="true" />
+
+ {/* Section 4: Test your first GitOps migration */}
+ <div className="border border-gray-200 rounded p-6 flex flex-col gap-y-3">
+ <div className="flex flex-col gap-y-1">
+ <h2 className="text-lg font-medium">
+ {t("gitops.test-setup.title")}
+ </h2>
+ <p className="text-sm text-control-light">
+ {t("gitops.test-setup.description")}
+ </p>
+ </div>
+
+ <div className="flex flex-col gap-y-2">
+ <div className="flex items-center gap-x-2">
+ <span className="text-sm text-control-light font-bold">
+ {SAMPLE_FILE_PATH}
+ </span>
+ </div>
+ <CodeBlock code={SAMPLE_SQL} />
+ </div>
+
+ <div className="flex flex-col gap-y-3">
+ <StepItem number={1}>
+ {t("gitops.test-setup.step-create-branch", { branch })}
+ </StepItem>
+ <StepItem number={2}>
+ {t("gitops.test-setup.step-sql-review")}
+ </StepItem>
+ <StepItem number={3}>{t("gitops.test-setup.step-merge")}</StepItem>
+ </div>
+
+ <p className="text-sm text-control-light">
+ {t("gitops.test-setup.naming-convention")}
+ </p>
+ </div>
+
+ {showCreateDrawer && (
+ <CreateWorkloadIdentityDrawer
+ project={projectName}
+ onClose={() => setShowCreateDrawer(false)}
+ onCreated={handleWorkloadIdentityCreated}
+ />
+ )}
+ </div>
+ );
+}
+
+// --- Helper components ---
+
+function FileHintLabel({
+ filePath,
+ repository,
+}: {
+ filePath: string;
+ repository?: string;
+}) {
+ const { t } = useTranslation();
+ // Split the translated template around placeholders to render bold spans,
+ // matching the Vue <i18n-t> slot behavior.
+ const raw = t("gitops.workflow.file-hint", {
+ filePath: "\x00FP\x00",
+ repository: "\x00RP\x00",
+ });
+ const parts = raw.split("\x00");
+ return (
+ <span>
+ {parts.map((part, i) =>
+ part === "FP" ? (
+ <span key={i} className="font-bold mx-1">
+ {filePath}
+ </span>
+ ) : part === "RP" ? (
+ <span key={i} className="font-bold mx-1">
+ {repository}
+ </span>
+ ) : (
+ <span key={i}>{part}</span>
+ )
+ )}
+ </span>
+ );
+}
+
+function CheckOrX({ ok }: { ok: boolean }) {
+ return ok ? (
+ <Check className="w-5 h-5 text-success shrink-0" />
+ ) : (
+ <XCircle className="w-5 h-5 text-warning shrink-0" />
+ );
+}
+
+function MissingExternalURLAttention() {
+ const { t } = useTranslation();
+ const canConfigure = hasWorkspacePermissionV2(
+ "bb.settings.setWorkspaceProfile"
+ );
+
+ return (
+ <Alert variant="error" className="mt-1">
+ <div className="flex flex-col gap-y-1">
+ <span className="font-medium">{t("banner.external-url")}</span>
+ <span>{t("settings.general.workspace.external-url.description")}</span>
+ {canConfigure && (
+ <Button
+ size="sm"
+ className="w-fit mt-1"
+ onClick={() =>
+ router.push({ name: SETTING_ROUTE_WORKSPACE_GENERAL })
+ }
+ >
+ {t("common.configure-now")}
+ </Button>
+ )}
+ </div>
+ </Alert>
+ );
+}
+
+function execCommandCopy(text: string): boolean {
+ const textarea = document.createElement("textarea");
+ textarea.value = text;
+ textarea.style.position = "fixed";
+ textarea.style.opacity = "0";
+ document.body.appendChild(textarea);
+ textarea.select();
+ try {
+ return document.execCommand("copy");
+ } catch {
+ return false;
+ } finally {
+ document.body.removeChild(textarea);
+ }
+}
+
+async function copyToClipboard(text: string): Promise<boolean> {
+ if (navigator.clipboard) {
+ try {
+ await navigator.clipboard.writeText(text);
+ return true;
+ } catch {
+ // Fall through to execCommand fallback
+ }
+ }
+ return execCommandCopy(text);
+}
+
+function CopyButton({ content }: { content: string }) {
+ const [copied, setCopied] = useState(false);
+
+ const handleCopy = async () => {
+ if (await copyToClipboard(content)) {
+ setCopied(true);
+ setTimeout(() => setCopied(false), 2000);
+ }
+ };
+
+ return (
+ <Button
+ variant="ghost"
+ size="icon"
+ className="h-7 w-7"
+ onClick={handleCopy}
+ >
+ {copied ? (
+ <Check className="h-4 w-4 text-success" />
+ ) : (
+ <Copy className="h-4 w-4" />
+ )}
+ </Button>
+ );
+}
+
+function CodeBlock({ code }: { code: string }) {
+ return (
+ <div className="relative rounded-xs p-4 bg-gray-50">
+ <div className="absolute top-2 right-2 p-2">
+ <CopyButton content={code} />
+ </div>
+ <div className="overflow-x-auto pr-12">
+ <pre className="text-sm font-mono whitespace-pre">{code}</pre>
+ </div>
+ </div>
+ );
+}
+
+function CollapsibleCode({
+ label,
+ code,
+ open,
+ onToggle,
+ className,
+}: {
+ label: React.ReactNode;
+ code: string;
+ open: boolean;
+ onToggle: () => void;
+ className?: string;
+}) {
+ return (
+ <div className={cn("flex flex-col gap-y-2", className)}>
+ <div>
+ <Button variant="ghost" size="sm" onClick={onToggle}>
+ {open ? (
+ <ChevronDown className="w-4 h-4" />
+ ) : (
+ <ChevronRight className="w-4 h-4" />
+ )}
+ {label}
+ </Button>
+ </div>
+ {open && <CodeBlock code={code} />}
+ </div>
+ );
+}
+
+function StepItem({
+ number,
+ children,
+}: {
+ number: number;
+ children: React.ReactNode;
+}) {
+ return (
+ <div className="flex items-start gap-x-3">
+ <span className="inline-flex items-center justify-center w-5 h-5 rounded-full bg-gray-200 text-gray-600 text-xs shrink-0 mt-0.5">
+ {number}
+ </span>
+ <p className="text-sm text-control-light">{children}</p>
+ </div>
+ );
+}
+
+function MultiDatabaseSelect({
+ value,
+ options,
+ onChange,
+ onSearch,
+}: {
+ value: string[];
+ options: ComboboxOption[];
+ onChange: (value: string[]) => void;
+ onSearch: (query: string) => void;
+}) {
+ const { t } = useTranslation();
+
+ const handleToggle = (dbName: string) => {
+ if (value.includes(dbName)) {
+ onChange(value.filter((n) => n !== dbName));
+ } else {
+ onChange([...value, dbName]);
+ }
+ };
+
+ return (
+ <div className="flex flex-col gap-y-2">
+ <Combobox
+ value=""
+ options={options.filter((o) => !value.includes(o.value))}
+ placeholder={t("database.select")}
+ onChange={handleToggle}
+ onSearch={onSearch}
+ />
+ {value.length > 0 && (
+ <div className="flex flex-wrap gap-1">
+ {value.map((name) => (
+ <span
+ key={name}
+ className="inline-flex items-center gap-x-1 px-2 py-0.5 text-xs bg-gray-100 rounded"
+ >
+ {extractDatabaseResourceName(name).databaseName}
+ <button
+ type="button"
+ className="hover:text-error"
+ onClick={() => onChange(value.filter((n) => n !== name))}
+ >
+ <XCircle className="w-3 h-3" />
+ </button>
+ </span>
+ ))}
+ </div>
+ )}
+ </div>
+ );
+}
+
+// --- YAML generators ---
+
+const SAMPLE_FILE_PATH = "migrations/20240101000000_create_sample_table.sql";
+const SAMPLE_SQL = `CREATE TABLE sample (
+ id SERIAL PRIMARY KEY,
+ name VARCHAR(255) NOT NULL,
+ created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);`;
+
+interface YamlParams {
+ branch: string;
+ runsOn?: string;
+ bytebaseUrl: string;
+ workloadIdentityEmail: string;
+ projectId: string;
+ targetsPlaceholder: string;
+}
+
+const exchangeTokenStep = (indent: string) =>
+ `${indent}- name: Exchange token
+${indent} id: bytebase-auth
+${indent} run: |
+${indent} OIDC_TOKEN=$(curl -s -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" \\
+${indent} "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=bytebase" | jq -r '.value')
+${indent} ACCESS_TOKEN=$(curl -s -X POST "$BYTEBASE_URL/v1/auth:exchangeToken" \\
+${indent} -H "Content-Type: application/json" \\
+${indent} -d "{\\"token\\":\\"$OIDC_TOKEN\\",\\"email\\":\\"$BYTEBASE_WORKLOAD_IDENTITY\\"}" \\
+${indent} | jq -r '.accessToken')
+${indent} echo "access-token=$ACCESS_TOKEN" >> $GITHUB_OUTPUT`;
+
+const accessTokenFlag =
+ "--access-token=${{ steps.bytebase-auth.outputs.access-token }}";
+
+function generateGithubSqlReviewYaml(p: YamlParams): string {
+ return `name: SQL Review
+on:
+ pull_request:
+ branches: ["${p.branch}"]
+ paths: ["migrations/*.sql"]
+jobs:
+ sql-review:
+ permissions:
+ id-token: write
+ pull-requests: write
+ runs-on: ${p.runsOn}
+ container:
+ image: bytebase/bytebase-action
+ env:
+ BYTEBASE_URL: ${p.bytebaseUrl}
+ BYTEBASE_WORKLOAD_IDENTITY: ${p.workloadIdentityEmail}
+ steps:
+ - uses: actions/checkout@v4
+${exchangeTokenStep(" ")}
+ - name: SQL Review
+ env:
+ GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
+ run: |
+ bytebase-action check \\
+ --url=$BYTEBASE_URL \\
+ ${accessTokenFlag} \\
+ --project=projects/${p.projectId} \\
+ --targets=${p.targetsPlaceholder} \\
+ --file-pattern=migrations/*.sql`;
+}
+
+function generateGithubReleaseYaml(p: YamlParams): string {
+ return `name: Rollout
+on:
+ push:
+ branches: ["${p.branch}"]
+ paths: ["migrations/*.sql"]
+env:
+ BYTEBASE_URL: ${p.bytebaseUrl}
+ BYTEBASE_WORKLOAD_IDENTITY: ${p.workloadIdentityEmail}
+ BYTEBASE_PROJECT: projects/${p.projectId}
+jobs:
+ build:
+ runs-on: ${p.runsOn}
+ steps:
+ - uses: actions/checkout@v4
+ - name: Build
+ run: echo "Building..."
+ create-rollout:
+ needs: build
+ permissions:
+ id-token: write
+ runs-on: ${p.runsOn}
+ container:
+ image: bytebase/bytebase-action
+ outputs:
+ bytebase-plan: \${{ steps.set-output.outputs.plan }}
+ steps:
+ - uses: actions/checkout@v4
+${exchangeTokenStep(" ")}
+ - name: Create rollout
+ run: |
+ bytebase-action rollout \\
+ --url=$BYTEBASE_URL \\
+ ${accessTokenFlag} \\
+ --project=$BYTEBASE_PROJECT \\
+ --targets=${p.targetsPlaceholder} \\
+ --file-pattern=migrations/*.sql \\
+ --output=\${{ runner.temp }}/bytebase-metadata.json
+ - name: Set output
+ id: set-output
+ run: |
+ PLAN=$(jq -r .plan \${{ runner.temp }}/bytebase-metadata.json)
+ echo "plan=$PLAN" >> $GITHUB_OUTPUT
+ deploy-to-test:
+ needs: create-rollout
+ permissions:
+ id-token: write
+ runs-on: ${p.runsOn}
+ environment: test
+ container:
+ image: bytebase/bytebase-action
+ steps:
+ - uses: actions/checkout@v4
+${exchangeTokenStep(" ")}
+ - name: Deploy to test
+ run: |
+ bytebase-action rollout \\
+ --url=$BYTEBASE_URL \\
+ ${accessTokenFlag} \\
+ --project=$BYTEBASE_PROJECT \\
+ --target-stage=environments/test \\
+ --plan=\${{ needs.create-rollout.outputs.bytebase-plan }}
+ deploy-to-prod:
+ needs: [deploy-to-test, create-rollout]
+ permissions:
+ id-token: write
+ runs-on: ${p.runsOn}
+ environment: prod
+ container:
+ image: bytebase/bytebase-action
+ steps:
+ - uses: actions/checkout@v4
+${exchangeTokenStep(" ")}
+ - name: Deploy to prod
+ run: |
+ bytebase-action rollout \\
+ --url=$BYTEBASE_URL \\
+ ${accessTokenFlag} \\
+ --project=$BYTEBASE_PROJECT \\
+ --target-stage=environments/prod \\
+ --plan=\${{ needs.create-rollout.outputs.bytebase-plan }}`;
+}
+
+const gitlabExchangeScript = ` - |
+ ACCESS_TOKEN=$(curl -s -X POST "$BYTEBASE_URL/v1/auth:exchangeToken" \\
+ -H "Content-Type: application/json" \\
+ -d "{\\"token\\":\\"$GITLAB_OIDC_TOKEN\\",\\"email\\":\\"$BYTEBASE_WORKLOAD_IDENTITY\\"}" \\
+ | jq -r '.accessToken')
+ export BYTEBASE_ACCESS_TOKEN=$ACCESS_TOKEN`;
+
+function generateGitlabCiYaml(p: YamlParams): string {
+ return `stages:
+ - sql-review
+ - create-rollout
+ - deploy-to-test
+ - deploy-to-prod
+
+variables:
+ BYTEBASE_URL: ${p.bytebaseUrl}
+ BYTEBASE_WORKLOAD_IDENTITY: ${p.workloadIdentityEmail}
+ BYTEBASE_PROJECT: projects/${p.projectId}
+ BYTEBASE_TARGETS: ${p.targetsPlaceholder}
+ FILE_PATTERN: "migrations/*.sql"
+
+sql-review:
+ stage: sql-review
+ image: bytebase/bytebase-action
+ id_tokens:
+ GITLAB_OIDC_TOKEN:
+ aud: bytebase
+ rules:
+ - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+ script:
+${gitlabExchangeScript}
+ - bytebase-action check --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --targets=$BYTEBASE_TARGETS --file-pattern=$FILE_PATTERN
+
+create-rollout:
+ stage: create-rollout
+ image: bytebase/bytebase-action
+ id_tokens:
+ GITLAB_OIDC_TOKEN:
+ aud: bytebase
+ rules:
+ - if: $CI_COMMIT_BRANCH == "${p.branch}"
+ script:
+${gitlabExchangeScript}
+ - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --targets=$BYTEBASE_TARGETS --file-pattern=$FILE_PATTERN --output=bytebase-metadata.json
+ artifacts:
+ paths: [bytebase-metadata.json]
+
+deploy-to-test:
+ stage: deploy-to-test
+ image: bytebase/bytebase-action
+ needs: [create-rollout]
+ id_tokens:
+ GITLAB_OIDC_TOKEN:
+ aud: bytebase
+ rules:
+ - if: $CI_COMMIT_BRANCH == "${p.branch}"
+ environment: test
+ script:
+${gitlabExchangeScript}
+ - PLAN=$(jq -r .plan bytebase-metadata.json)
+ - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --target-stage=environments/test --plan=$PLAN
+
+deploy-to-prod:
+ stage: deploy-to-prod
+ image: bytebase/bytebase-action
+ needs: [deploy-to-test]
+ id_tokens:
+ GITLAB_OIDC_TOKEN:
+ aud: bytebase
+ rules:
+ - if: $CI_COMMIT_BRANCH == "${p.branch}"
+ environment: prod
+ when: manual
+ script:
+${gitlabExchangeScript}
+ - PLAN=$(jq -r .plan bytebase-metadata.json)
+ - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --target-stage=environments/prod --plan=$PLAN`;
+}
diff --git a/frontend/src/react/pages/settings/WorkloadIdentitiesPage.tsx b/frontend/src/react/pages/settings/WorkloadIdentitiesPage.tsx
index 85a2ba3b95..f676f89ccd 100644
--- a/frontend/src/react/pages/settings/WorkloadIdentitiesPage.tsx
+++ b/frontend/src/react/pages/settings/WorkloadIdentitiesPage.tsx
@@ -1,50 +1,24 @@
-import { create } from "@bufbuild/protobuf";
-import { FieldMaskSchema } from "@bufbuild/protobuf/wkt";
-import {
- ChevronDown,
- ChevronUp,
- Pencil,
- Plus,
- Trash2,
- Undo2,
- X,
-} from "lucide-react";
-import { useCallback, useEffect, useMemo, useRef, useState } from "react";
+import { Pencil, Plus, Trash2, Undo2 } from "lucide-react";
+import { useCallback, useState } from "react";
import { useTranslation } from "react-i18next";
import { ComponentPermissionGuard } from "@/react/components/ComponentPermissionGuard";
+import { CreateWorkloadIdentityDrawer } from "@/react/components/CreateWorkloadIdentityDrawer";
import { Button } from "@/react/components/ui/button";
-import { Input } from "@/react/components/ui/input";
import { Tooltip } from "@/react/components/ui/tooltip";
-import { useEscapeKey } from "@/react/hooks/useEscapeKey";
import { useVueState } from "@/react/hooks/useVueState";
import {
ensureWorkloadIdentityFullName,
pushNotification,
useActuatorV1Store,
- useWorkspaceV1Store,
} from "@/store";
import {
useWorkloadIdentityStore,
workloadIdentityToUser,
} from "@/store/modules/workloadIdentity";
-import {
- getWorkloadIdentityNameInBinding,
- getWorkloadIdentitySuffix,
-} from "@/types";
import { State } from "@/types/proto-es/v1/common_pb";
import type { User } from "@/types/proto-es/v1/user_service_pb";
import type { WorkloadIdentity } from "@/types/proto-es/v1/workload_identity_service_pb";
-import {
- WorkloadIdentityConfig_ProviderType,
- WorkloadIdentityConfigSchema,
- WorkloadIdentitySchema,
-} from "@/types/proto-es/v1/workload_identity_service_pb";
-import {
- getWorkloadIdentityProviderText,
- hasWorkspacePermissionV2,
- parseWorkloadIdentitySubjectPattern,
-} from "@/utils";
-import { RoleMultiSelect } from "./shared/RoleMultiSelect";
+import { hasWorkspacePermissionV2 } from "@/utils";
import { UserAvatar } from "./shared/UserAvatar";
import { PagedTableFooter, usePagedData } from "./shared/usePagedData";
@@ -222,556 +196,6 @@ function WorkloadIdentityTable({
);
}
-// ============================================================
-// CreateWorkloadIdentityDrawer
-// ============================================================
-
-type RefType = "branch" | "tag" | "all";
-
-const PLATFORM_PRESETS: Partial<
- Record<
- WorkloadIdentityConfig_ProviderType,
- { issuerUrl: string; audience: string }
- >
-> = {
- [WorkloadIdentityConfig_ProviderType.GITHUB]: {
- issuerUrl: "https://token.actions.githubusercontent.com",
- audience: "",
- },
- [WorkloadIdentityConfig_ProviderType.GITLAB]: {
- issuerUrl: "https://gitlab.com",
- audience: "",
- },
-};
-
-function computeSubjectPattern(
- providerType: WorkloadIdentityConfig_ProviderType,
- owner: string,
- repo: string,
- branch: string,
- refType: RefType
-): string {
- if (providerType === WorkloadIdentityConfig_ProviderType.GITHUB) {
- if (!repo) return `repo:${owner}/*`;
- if (!branch) return `repo:${owner}/${repo}:*`;
- return `repo:${owner}/${repo}:ref:refs/heads/${branch}`;
- }
- if (providerType === WorkloadIdentityConfig_ProviderType.GITLAB) {
- if (!repo) return `project_path:${owner}/*`;
- if (refType === "all" || !branch) return `project_path:${owner}/${repo}:*`;
- return `project_path:${owner}/${repo}:ref_type:${refType}:ref:${branch}`;
- }
- return "";
-}
-
-function CreateWorkloadIdentityDrawer({
- workloadIdentity,
- project,
- onClose,
- onCreated,
- onUpdated,
-}: {
- workloadIdentity?: WorkloadIdentity;
- project?: string;
- onClose: () => void;
- onCreated: (wi: WorkloadIdentity) => void;
- onUpdated: (wi: WorkloadIdentity) => void;
-}) {
- const { t } = useTranslation();
- const workloadIdentityStore = useWorkloadIdentityStore();
- const workspaceStore = useWorkspaceV1Store();
- const actuatorStore = useActuatorV1Store();
-
- const isEditMode = !!workloadIdentity && !!workloadIdentity.email;
-
- // Form state
- const [title, setTitle] = useState(workloadIdentity?.title ?? "");
- const [emailPrefix, setEmailPrefix] = useState(() => {
- if (workloadIdentity?.email) {
- return workloadIdentity.email.split("@")[0];
- }
- return "";
- });
-
- const emailSuffix = useMemo(() => {
- const projectId = project ? project.replace(/^projects\//, "") : "";
- return getWorkloadIdentitySuffix(projectId || undefined);
- }, [project]);
-
- const parent = useMemo(
- () => project ?? actuatorStore.workspaceResourceName,
- [project, actuatorStore]
- );
-
- // WIF state
- const [providerType, setProviderType] =
- useState<WorkloadIdentityConfig_ProviderType>(
- workloadIdentity?.workloadIdentityConfig?.providerType ??
- WorkloadIdentityConfig_ProviderType.GITHUB
- );
- const [owner, setOwner] = useState("");
- const [repo, setRepo] = useState("");
- const [branch, setBranch] = useState("");
- const [refType, setRefType] = useState<RefType>("all");
- const [issuerUrl, setIssuerUrl] = useState(
- PLATFORM_PRESETS[WorkloadIdentityConfig_ProviderType.GITHUB]!.issuerUrl
- );
- const [audience, setAudience] = useState("");
- const [subjectPattern, setSubjectPattern] = useState("");
- const [showAdvanced, setShowAdvanced] = useState(false);
- const [roles, setRoles] = useState<string[]>([]);
- const [isRequesting, setIsRequesting] = useState(false);
-
- // Circular update prevention refs
- const isUpdatingFromPatternRef = useRef(false);
- const isUpdatingFromFieldsRef = useRef(false);
-
- // Initialize from existing workload identity
- useEffect(() => {
- if (!workloadIdentity) return;
- setTitle(workloadIdentity.title);
- setEmailPrefix(workloadIdentity.email.split("@")[0]);
-
- const config = workloadIdentity.workloadIdentityConfig;
- if (config) {
- setProviderType(config.providerType);
- setIssuerUrl(config.issuerUrl);
- setAudience(config.allowedAudiences[0] ?? "");
- setSubjectPattern(config.subjectPattern);
-
- const parsed = parseWorkloadIdentitySubjectPattern(workloadIdentity);
- if (parsed) {
- setOwner(parsed.owner);
- setRepo(parsed.repo);
- setBranch(parsed.branch);
- if ("refType" in parsed && parsed.refType) {
- setRefType(parsed.refType);
- }
- }
- }
- }, []);
-
- // When fields change -> update subject pattern
- useEffect(() => {
- if (isUpdatingFromPatternRef.current) return;
- isUpdatingFromFieldsRef.current = true;
- setSubjectPattern(
- computeSubjectPattern(providerType, owner, repo, branch, refType)
- );
- isUpdatingFromFieldsRef.current = false;
- }, [owner, repo, branch, providerType, refType]);
-
- // When subject pattern changes -> reverse-parse fields
- useEffect(() => {
- if (isUpdatingFromFieldsRef.current) return;
- const parsed = parseWorkloadIdentitySubjectPattern({
- workloadIdentityConfig: {
- subjectPattern,
- providerType,
- },
- });
- if (parsed) {
- isUpdatingFromPatternRef.current = true;
- setOwner(parsed.owner);
- setRepo(parsed.repo);
- setBranch(parsed.branch);
- if ("refType" in parsed && parsed.refType) {
- setRefType(parsed.refType);
- }
- isUpdatingFromPatternRef.current = false;
- }
- }, [subjectPattern]);
-
- useEscapeKey(true, onClose);
-
- const handlePlatformChange = (value: WorkloadIdentityConfig_ProviderType) => {
- setProviderType(value);
- const preset = PLATFORM_PRESETS[value];
- if (preset) {
- setIssuerUrl(preset.issuerUrl);
- setAudience(preset.audience);
- }
- setRefType("all");
- setBranch("");
- };
-
- const allowConfirm = useMemo(() => {
- if (!emailPrefix && !workloadIdentity?.email) return false;
- if (!owner) return false;
- if (!issuerUrl) return false;
- return true;
- }, [emailPrefix, workloadIdentity?.email, owner, issuerUrl]);
-
- const hasPermission = hasWorkspacePermissionV2(
- isEditMode ? "bb.workloadIdentities.update" : "bb.workloadIdentities.create"
- );
-
- const handleSubmit = async () => {
- if (!allowConfirm || !hasPermission) return;
- setIsRequesting(true);
- try {
- if (isEditMode) {
- await handleUpdate();
- } else {
- await handleCreate();
- }
- } catch {
- // error shown by store
- } finally {
- setIsRequesting(false);
- }
- };
-
- const handleCreate = async () => {
- const wi = await workloadIdentityStore.createWorkloadIdentity(
- emailPrefix,
- {
- title: title || emailPrefix,
- workloadIdentityConfig: create(WorkloadIdentityConfigSchema, {
- providerType,
- issuerUrl,
- allowedAudiences: audience ? [audience] : [],
- subjectPattern,
- }),
- },
- parent
- );
-
- if (roles.length > 0) {
- await workspaceStore.patchIamPolicy([
- {
- member: getWorkloadIdentityNameInBinding(wi.email),
- roles,
- },
- ]);
- }
-
- onCreated(wi);
- pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: t("common.created"),
- });
- onClose();
- };
-
- const handleUpdate = async () => {
- if (!workloadIdentity) return;
-
- const updateMask: string[] = [];
- if (title !== workloadIdentity.title) {
- updateMask.push("title");
- }
-
- const updated = await workloadIdentityStore.updateWorkloadIdentity(
- create(WorkloadIdentitySchema, {
- name: ensureWorkloadIdentityFullName(workloadIdentity.email),
- title,
- workloadIdentityConfig: create(WorkloadIdentityConfigSchema, {
- providerType,
- issuerUrl,
- allowedAudiences: audience ? [audience] : [],
- subjectPattern,
- }),
- }),
- create(FieldMaskSchema, {
- paths: [...updateMask, "workload_identity_config"],
- })
- );
-
- onUpdated(updated);
- pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: t("common.updated"),
- });
- onClose();
- };
-
- const isGitLab = providerType === WorkloadIdentityConfig_ProviderType.GITLAB;
- const showBranchField =
- providerType === WorkloadIdentityConfig_ProviderType.GITHUB ||
- refType !== "all";
- const isTagRefType = isGitLab && refType === "tag";
-
- return (
- <>
- {/* Backdrop */}
- <div className="fixed inset-0 z-40 bg-black/30" onClick={onClose} />
-
- {/* Drawer */}
- <div
- role="dialog"
- aria-modal="true"
- className="fixed inset-y-0 right-0 z-50 w-[40rem] max-w-[100vw] bg-white shadow-xl flex flex-col"
- >
- {/* Header */}
- <div className="flex items-center justify-between px-6 py-4 border-b">
- <h2 className="text-lg font-medium">
- {isEditMode
- ? t("settings.members.update-workload-identity")
- : t("settings.members.add-workload-identity")}
- </h2>
- <Button variant="ghost" size="icon" onClick={onClose}>
- <X className="h-5 w-5" />
- </Button>
- </div>
-
- {/* Content */}
- <div className="flex-1 overflow-auto px-6 py-6">
- <div className="flex flex-col gap-y-6">
- {/* Title */}
- <div className="flex flex-col gap-y-2">
- <label className="block text-sm font-medium text-control">
- {t("common.name")}
- </label>
- <Input
- value={title}
- onChange={(e) => setTitle(e.target.value)}
- placeholder="GitHub Deploy"
- maxLength={200}
- autoComplete="off"
- />
- </div>
-
- {/* Email */}
- <div className="flex flex-col gap-y-2">
- <label className="block text-sm font-medium text-control">
- {t("common.email")}
- <span className="ml-0.5 text-error">*</span>
- </label>
- {isEditMode ? (
- <Input value={workloadIdentity!.email} disabled />
- ) : (
- <div className="flex items-center">
- <Input
- value={emailPrefix}
- onChange={(e) => setEmailPrefix(e.target.value)}
- placeholder="my-workflow"
- autoComplete="off"
- className="rounded-r-none"
- />
- <span className="inline-flex items-center px-3 h-9 border border-l-0 border-control-border bg-control-bg text-sm text-control rounded-r-xs whitespace-nowrap">
- @{emailSuffix}
- </span>
- </div>
- )}
- </div>
-
- {/* Platform */}
- <div className="flex flex-col gap-y-2">
- <label className="block text-sm font-medium text-control">
- {t("settings.members.workload-identity-platform")}
- <span className="ml-0.5 text-error">*</span>
- </label>
- <select
- value={providerType}
- onChange={(e) =>
- handlePlatformChange(
- Number(
- e.target.value
- ) as WorkloadIdentityConfig_ProviderType
- )
- }
- className="border border-control-border rounded-xs text-sm px-2 py-2 bg-white"
- >
- {[
- WorkloadIdentityConfig_ProviderType.GITHUB,
- WorkloadIdentityConfig_ProviderType.GITLAB,
- ].map((pt) => (
- <option key={pt} value={pt}>
- {getWorkloadIdentityProviderText(pt)}
- </option>
- ))}
- </select>
- </div>
-
- {/* Owner / Group */}
- <div className="flex flex-col gap-y-2">
- <label className="block text-sm font-medium text-control">
- {isGitLab
- ? t("settings.members.workload-identity-group")
- : t("settings.members.workload-identity-owner")}
- <span className="ml-0.5 text-error">*</span>
- </label>
- <Input
- value={owner}
- onChange={(e) => setOwner(e.target.value)}
- placeholder={isGitLab ? "my-group" : "my-org"}
- maxLength={200}
- autoComplete="off"
- />
- </div>
-
- {/* Repository / Project */}
- <div className="flex flex-col gap-y-2">
- <label className="block text-sm font-medium text-control">
- {isGitLab
- ? t("settings.members.workload-identity-project")
- : t("settings.members.workload-identity-repo")}
- </label>
- <Input
- value={repo}
- onChange={(e) => setRepo(e.target.value)}
- placeholder={isGitLab ? "my-project" : "my-repo"}
- maxLength={200}
- autoComplete="off"
- />
- <span className="text-xs text-gray-500">
- {isGitLab
- ? t("settings.members.workload-identity-project-hint")
- : t("settings.members.workload-identity-repo-hint")}
- </span>
- </div>
-
- {/* Allowed Branches/Tags (GitLab only) */}
- {isGitLab && (
- <div className="flex flex-col gap-y-2">
- <label className="block text-sm font-medium text-control">
- {t(
- "settings.members.workload-identity-allowed-branches-tags"
- )}
- </label>
- <select
- value={refType}
- onChange={(e) => setRefType(e.target.value as RefType)}
- className="border border-control-border rounded-xs text-sm px-2 py-2 bg-white"
- >
- <option value="all">
- {t("settings.members.workload-identity-all-branches-tags")}
- </option>
- <option value="branch">
- {t("settings.members.workload-identity-specific-branch")}
- </option>
- <option value="tag">
- {t("settings.members.workload-identity-specific-tag")}
- </option>
- </select>
- </div>
- )}
-
- {/* Branch / Tag */}
- {showBranchField && (
- <div className="flex flex-col gap-y-2">
- <label className="block text-sm font-medium text-control">
- {isTagRefType
- ? t("settings.members.workload-identity-tag")
- : t("settings.members.workload-identity-branch")}
- </label>
- <Input
- value={branch}
- onChange={(e) => setBranch(e.target.value)}
- placeholder={isTagRefType ? "v1.0.0" : "main"}
- maxLength={200}
- autoComplete="off"
- />
- <span className="text-xs text-gray-500">
- {isTagRefType
- ? t("settings.members.workload-identity-tag-hint")
- : t("settings.members.workload-identity-branch-hint")}
- </span>
- </div>
- )}
-
- {/* Advanced Settings */}
- {showAdvanced && (
- <div className="flex flex-col gap-y-6 pt-6 border-t">
- {/* Issuer URL / GitLab URL */}
- <div className="flex flex-col gap-y-2">
- <label className="block text-sm font-medium text-control">
- {isGitLab
- ? t("settings.members.workload-identity-gitlab-url")
- : t("settings.members.workload-identity-issuer")}
- </label>
- <Input
- value={issuerUrl}
- onChange={(e) => setIssuerUrl(e.target.value)}
- maxLength={500}
- autoComplete="off"
- />
- {isGitLab && (
- <span className="text-xs text-gray-500">
- {t("settings.members.workload-identity-gitlab-url-hint")}
- </span>
- )}
- </div>
-
- {/* Audience */}
- <div className="flex flex-col gap-y-2">
- <label className="block text-sm font-medium text-control">
- {t("settings.members.workload-identity-audience")}
- </label>
- <Input
- value={audience}
- onChange={(e) => setAudience(e.target.value)}
- maxLength={500}
- autoComplete="off"
- />
- </div>
-
- {/* Subject Pattern */}
- <div className="flex flex-col gap-y-2">
- <label className="block text-sm font-medium text-control">
- {t("settings.members.workload-identity-subject")}
- </label>
- <Input
- value={subjectPattern}
- onChange={(e) => setSubjectPattern(e.target.value)}
- maxLength={500}
- autoComplete="off"
- />
- </div>
- </div>
- )}
-
- {/* Advanced Settings Toggle */}
- <button
- type="button"
- className="flex items-center gap-x-1 text-sm text-accent hover:underline w-fit"
- onClick={() => setShowAdvanced(!showAdvanced)}
- >
- {t("settings.members.workload-identity-advanced")}
- {showAdvanced ? (
- <ChevronUp className="w-4 h-4" />
- ) : (
- <ChevronDown className="w-4 h-4" />
- )}
- </button>
-
- {/* Roles (create mode only) */}
- {!isEditMode &&
- hasWorkspacePermissionV2("bb.workspaces.setIamPolicy") && (
- <div className="flex flex-col gap-y-2">
- <label className="block text-sm font-medium text-control">
- {t("settings.members.table.roles")}
- </label>
- <RoleMultiSelect
- value={roles}
- onChange={setRoles}
- disabled={false}
- />
- </div>
- )}
- </div>
- </div>
-
- {/* Footer */}
- <div className="flex items-center justify-end gap-x-2 px-6 py-4 border-t">
- <Button variant="outline" onClick={onClose}>
- {t("common.cancel")}
- </Button>
- <Button
- disabled={!allowConfirm || !hasPermission || isRequesting}
- onClick={handleSubmit}
- >
- {isEditMode ? t("common.update") : t("common.confirm")}
- </Button>
- </div>
- </div>
- </>
- );
-}
-
// ============================================================
// WorkloadIdentitiesPage (main)
// ============================================================
diff --git a/frontend/src/router/dashboard/projectV1.ts b/frontend/src/router/dashboard/projectV1.ts
index 4a8f104143..171b137c43 100644
--- a/frontend/src/router/dashboard/projectV1.ts
+++ b/frontend/src/router/dashboard/projectV1.ts
@@ -472,7 +472,7 @@ const projectV1Routes: RouteRecordRaw[] = [
"bb.databases.list",
],
},
- component: () => import("@/views/project/ProjectGitOpsDashboard.vue"),
+ component: () => import("@/react/ProjectGitOpsPageMount.vue"),
props: true,
},
...planRoutes,
diff --git a/frontend/src/views/project/ProjectGitOpsDashboard.vue b/frontend/src/views/project/ProjectGitOpsDashboard.vue
deleted file mode 100644
index 8a0d9dc213..0000000000
--- a/frontend/src/views/project/ProjectGitOpsDashboard.vue
+++ /dev/null
@@ -1,835 +0,0 @@
-<template>
- <div class="w-full px-4 flex flex-col gap-y-1 py-4">
- <!-- Section 1: What is GitOps -->
- <div class="border border-gray-200 rounded p-6 flex flex-col gap-y-3">
- <div class="flex flex-col gap-y-1">
- <h2 class="text-lg font-medium">
- {{ $t("gitops.overview.title") }}
- </h2>
- <p class="textinfolabel">
- {{ $t("gitops.overview.description") }}
- </p>
- <p class="textinfolabel">
- {{ $t("gitops.overview.description-git") }}
- </p>
- </div>
- <img
- :src="gitopsWorkflowImage"
- alt="GitOps Workflow"
- class="w-full max-w-4xl object-contain my-2"
- />
- <!-- Documentation link -->
- <div>
- <a
- href="https://docs.bytebase.com/gitops/overview?source=console"
- target="_blank"
- class="text-accent hover:underline"
- >
- {{ $t("gitops.documentation") }} &rarr;
- </a>
- </div>
- </div>
-
- <span
- class="mx-auto w-0.5 h-8 bg-block-border"
- aria-hidden="true"
- ></span>
-
- <!-- Section 2: Checks before we start -->
- <div class="border border-gray-200 rounded p-6 flex flex-col gap-y-3">
- <h2 class="text-lg font-medium">
- {{ $t("gitops.checklist.title") }}
- </h2>
-
- <!-- WIF notice for Bitbucket / Azure DevOps -->
- <BBAttention :type="'info'" :closable="false">
- <span>{{ $t("gitops.checklist.wif-notice-text") }}
- <a
- href="https://docs.bytebase.com/tutorials/gitops-bitbucket-workflow?source=console"
- target="_blank"
- class="text-accent hover:underline"
- >Bitbucket</a>
- /
- <a
- href="https://docs.bytebase.com/tutorials/gitops-azure-devops-workflow?source=console"
- target="_blank"
- class="text-accent hover:underline"
- >Azure DevOps</a>
- {{ $t("gitops.checklist.wif-notice-suffix") }}
- </span>
- </BBAttention>
-
- <!-- Check 1: External URL -->
- <div class="flex items-start gap-x-3 py-3">
- <CheckIcon
- v-if="bytebaseUrl"
- class="w-5 h-5 text-success shrink-0"
- />
- <XCircleIcon
- v-else
- class="w-5 h-5 text-warning shrink-0"
- />
-
- <div class="flex flex-col flex-1 gap-y-1">
- <span class="text-sm font-medium">
- {{ $t("gitops.checklist.external-url") }}
- </span>
- <span v-if="bytebaseUrl" class="text-sm text-control-light">
- {{ bytebaseUrl }}
- </span>
- <MissingExternalURLAttention class="mt-1" />
- </div>
- </div>
-
- <!-- Check 2: Workload Identity -->
- <div class="flex items-start gap-x-3 py-3">
- <CheckIcon
- v-if="selectedIdentityName"
- class="w-5 h-5 text-success shrink-0"
- />
- <XCircleIcon
- v-else
- class="w-5 h-5 text-warning shrink-0"
- />
- <div class="flex flex-col gap-y-2 flex-1">
- <span class="text-sm font-medium">{{
- $t("gitops.checklist.workload-identity")
- }}</span>
- <div class="flex items-center gap-x-3">
- <WorkloadIdentitySelect
- v-model:value="selectedIdentityName"
- :parent="projectName"
- :placeholder="
- $t('gitops.workload-identity.select-placeholder')
- "
- clearable
- class="max-w-lg"
- />
- <PermissionGuardWrapper
- v-slot="slotProps"
- :project="project"
- :permissions="[
- 'bb.workloadIdentities.create'
- ]"
- >
- <NButton :disabled="slotProps.disabled" @click="showCreateDrawer = true">
- {{ $t("common.create") }}
- </NButton>
- </PermissionGuardWrapper>
- </div>
- <a
- v-if="repoUrl"
- :href="repoUrl"
- target="_blank"
- class="text-sm text-accent hover:underline"
- >
- {{ repoUrl }} &rarr;
- </a>
- </div>
- </div>
-
- <!-- Check 3: Target Databases -->
- <div class="flex items-start gap-x-3 py-3">
- <CheckIcon
- v-if="hasTargetSelected"
- class="w-5 h-5 text-success shrink-0"
- />
- <XCircleIcon
- v-else
- class="w-5 h-5 text-warning shrink-0"
- />
- <div class="flex flex-col gap-y-2 flex-1">
- <span class="text-sm font-medium">{{
- $t("gitops.checklist.target-databases")
- }}</span>
- <NButtonGroup size="small">
- <NButton
- :type="targetTab === 'GROUP' ? 'primary' : 'default'"
- :secondary="targetTab === 'GROUP'"
- @click="handleTargetTabChange('GROUP')"
- >
- {{ $t("common.database-group") }}
- </NButton>
- <NButton
- :type="targetTab === 'DATABASE' ? 'primary' : 'default'"
- :secondary="targetTab === 'DATABASE'"
- @click="handleTargetTabChange('DATABASE')"
- >
- {{ $t("common.databases") }}
- </NButton>
- </NButtonGroup>
- <div class="max-w-lg">
- <template v-if="targetTab === 'GROUP'">
- <NSelect
- :value="selectedDatabaseGroupName"
- :options="dbGroupOptions"
- :placeholder="$t('database-group.select')"
- clearable
- @update:value="selectedDatabaseGroupName = $event"
- />
- <p class="text-xs text-control-light mt-1">
- {{ $t("gitops.checklist.database-group-recommendation") }}
- </p>
- </template>
- <DatabaseSelect
- v-else
- v-model:value="selectedDatabaseNames"
- :project-name="projectName"
- :multiple="true"
- />
- </div>
- <p
- v-if="targetsString"
- class="text-sm text-control-light"
- >
- <span class="font-medium">targets:</span>
- <code class="text-xs bg-gray-100 px-1 py-0.5 rounded">{{
- targetsString
- }}</code>
- </p>
- </div>
- </div>
- </div>
-
- <span
- class="mx-auto w-0.5 h-8 bg-block-border"
- aria-hidden="true"
- ></span>
-
- <!-- Section 3: Workflow file generation -->
- <div class="border border-gray-200 rounded p-6 flex flex-col gap-y-3">
- <div class="flex flex-col gap-y-1">
- <h2 class="text-lg font-medium">
- {{ $t("gitops.workflow.title") }}
- </h2>
- <p class="text-sm text-control-light">
- {{ $t("gitops.workflow.description") }}
- </p>
- </div>
-
- <NTabs v-model:value="activeTab" type="line" animated class="gitops-vcs-tabs">
- <NTabPane :name="WorkloadIdentityConfig_ProviderType.GITHUB" tab="GitHub Actions">
- <BBAttention v-if="selectedConfig && activeTab !== selectedConfig?.providerType" :type="'error'">
- {{ $t("gitops.workflow.provider-not-match", { provider: getWorkloadIdentityProviderText(selectedConfig.providerType) }) }}
- </BBAttention>
- <!-- Runner type toggle -->
- <div class="flex items-center gap-x-2 my-3">
- <span class="text-sm">
- {{ $t("gitops.workflow.self-hosted-runner") }}
- </span>
- <NSwitch v-model:value="useSelfhostRunner" />
- </div>
- <!-- sql-review.yml -->
- <div class="flex flex-col gap-y-2">
- <div>
- <NButton quaternary size="small" @click="showSqlReviewYaml = !showSqlReviewYaml">
- <template #icon>
- <ChevronRightIcon
- v-if="!showSqlReviewYaml"
- class="w-4 h-4"
- />
- <ChevronDownIcon v-else class="w-4 h-4" />
- </template>
- <i18n-t keypath="gitops.workflow.file-hint">
- <template #filePath>
- <span class="font-bold mx-1">
- .github/workflows/sql-review.yml
- </span>
- </template>
- <template #repository>
- <span class="font-bold mx-1">
- {{ parsedSubject?.repo }}
- </span>
- </template>
- </i18n-t>
- </NButton>
- </div>
- <div
- v-show="showSqlReviewYaml"
- class="relative rounded-xs p-4 bg-gray-50"
- >
- <div class="absolute top-2 right-2 p-2">
- <CopyButton size="medium" :content="githubSqlReviewYaml" />
- </div>
- <div class="overflow-x-auto pr-12">
- <NConfigProvider :hljs="hljs">
- <NCode language="yaml" :code="githubSqlReviewYaml" />
- </NConfigProvider>
- </div>
- </div>
- </div>
- <!-- release.yml -->
- <div class="flex flex-col gap-y-2 mt-4">
- <div>
- <NButton quaternary size="small" @click="showReleaseYaml = !showReleaseYaml">
- <template #icon>
- <ChevronRightIcon
- v-if="!showReleaseYaml"
- class="w-4 h-4"
- />
- <ChevronDownIcon v-else class="w-4 h-4" />
- </template>
- <i18n-t keypath="gitops.workflow.file-hint">
- <template #filePath>
- <span class="font-bold mx-1">
- .github/workflows/release.yml
- </span>
- </template>
- <template #repository>
- <span class="font-bold mx-1">
- {{ parsedSubject?.repo }}
- </span>
- </template>
- </i18n-t>
- </NButton>
- </div>
- <div
- v-show="showReleaseYaml"
- class="relative rounded-xs p-4 bg-gray-50"
- >
- <div class="absolute top-2 right-2 p-2">
- <CopyButton size="medium" :content="githubReleaseYaml" />
- </div>
- <div class="overflow-x-auto pr-12">
- <NConfigProvider :hljs="hljs">
- <NCode language="yaml" :code="githubReleaseYaml" />
- </NConfigProvider>
- </div>
- </div>
- </div>
- </NTabPane>
- <NTabPane :name="WorkloadIdentityConfig_ProviderType.GITLAB" tab="GitLab CI">
- <div class="flex flex-col gap-y-2">
- <BBAttention v-if="selectedConfig && activeTab !== selectedConfig?.providerType" :type="'error'">
- {{ $t("gitops.workflow.provider-not-match", { provider: getWorkloadIdentityProviderText(selectedConfig.providerType) }) }}
- </BBAttention>
- <div>
- <NButton quaternary size="small" @click="showGitlabCiYaml = !showGitlabCiYaml">
- <template #icon>
- <ChevronRightIcon
- v-if="!showGitlabCiYaml"
- class="w-4 h-4"
- />
- <ChevronDownIcon v-else class="w-4 h-4" />
- </template>
- <i18n-t keypath="gitops.workflow.file-hint">
- <template #filePath>
- <span class="font-bold mx-1">
- .gitlab-ci.yml
- </span>
- </template>
- <template #repository>
- <span class="font-bold mx-1">
- {{ parsedSubject?.repo }}
- </span>
- </template>
- </i18n-t>
- </NButton>
- </div>
- <div
- v-show="showGitlabCiYaml"
- class="relative rounded-xs p-4 bg-gray-50"
- >
- <div class="absolute top-2 right-2 p-2">
- <CopyButton size="medium" :content="gitlabCiYaml" />
- </div>
- <div class="overflow-x-auto pr-12">
- <NConfigProvider :hljs="hljs">
- <NCode language="yaml" :code="gitlabCiYaml" />
- </NConfigProvider>
- </div>
- </div>
- </div>
- </NTabPane>
- </NTabs>
- </div>
-
- <span
- class="mx-auto w-0.5 h-8 bg-block-border"
- aria-hidden="true"
- ></span>
-
- <!-- Section 4: Test your first GitOps migration -->
- <div class="border border-gray-200 rounded p-6 flex flex-col gap-y-3">
- <div class="flex flex-col gap-y-1">
- <h2 class="text-lg font-medium">
- {{ $t("gitops.test-setup.title") }}
- </h2>
- <p class="text-sm text-control-light">
- {{ $t("gitops.test-setup.description") }}
- </p>
- </div>
-
- <!-- Sample migration file -->
- <div class="flex flex-col gap-y-2">
- <div class="flex items-center gap-x-2">
- <span class="text-sm text-control-light font-bold">{{ sampleFilePath }}</span>
- </div>
- <div class="relative rounded-xs p-4 bg-gray-50">
- <div class="absolute top-2 right-2 p-2">
- <CopyButton size="medium" :content="sampleSql" />
- </div>
- <div class="overflow-x-auto pr-12">
- <NConfigProvider :hljs="hljs">
- <NCode language="sql" :code="sampleSql" />
- </NConfigProvider>
- </div>
- </div>
- </div>
-
- <!-- Step-by-step instructions -->
- <div class="flex flex-col gap-y-3">
- <div class="flex items-start gap-x-3">
- <span
- class="inline-flex items-center justify-center w-5 h-5 rounded-full bg-gray-200 text-gray-600 text-xs shrink-0 mt-0.5"
- >
- 1
- </span>
- <p class="text-sm text-control-light">
- {{
- $t("gitops.test-setup.step-create-branch", {
- branch: branch,
- })
- }}
- </p>
- </div>
- <div class="flex items-start gap-x-3">
- <span
- class="inline-flex items-center justify-center w-5 h-5 rounded-full bg-gray-200 text-gray-600 text-xs shrink-0 mt-0.5"
- >
- 2
- </span>
- <p class="text-sm text-control-light">
- {{ $t("gitops.test-setup.step-sql-review") }}
- </p>
- </div>
- <div class="flex items-start gap-x-3">
- <span
- class="inline-flex items-center justify-center w-5 h-5 rounded-full bg-gray-200 text-gray-600 text-xs shrink-0 mt-0.5"
- >
- 3
- </span>
- <p class="text-sm text-control-light">
- {{ $t("gitops.test-setup.step-merge") }}
- </p>
- </div>
- </div>
-
- <!-- Naming convention hint -->
- <p class="text-sm text-control-light">
- {{ $t("gitops.test-setup.naming-convention") }}
- </p>
- </div>
- </div>
-
- <CreateWorkloadIdentityDrawer
- v-if="showCreateDrawer"
- :project="projectName"
- @close="showCreateDrawer = false"
- @created="handleWorkloadIdentityCreated"
- />
-</template>
-
-<script lang="ts" setup>
-import hljs from "highlight.js/lib/core";
-import {
- CheckIcon,
- ChevronDownIcon,
- ChevronRightIcon,
- XCircleIcon,
-} from "lucide-vue-next";
-import {
- NButton,
- NButtonGroup,
- NCode,
- NConfigProvider,
- NSelect,
- NSwitch,
- NTabPane,
- NTabs,
-} from "naive-ui";
-import { computed, ref, watch } from "vue";
-import gitopsWorkflowImage from "@/assets/gitops-workflow.svg";
-import { BBAttention } from "@/bbkit";
-import PermissionGuardWrapper from "@/components/Permission/PermissionGuardWrapper.vue";
-import CreateWorkloadIdentityDrawer from "@/components/User/Settings/CreateWorkloadIdentityDrawer.vue";
-import {
- CopyButton,
- DatabaseSelect,
- WorkloadIdentitySelect,
-} from "@/components/v2";
-import { MissingExternalURLAttention } from "@/components/v2/Form";
-import {
- extractWorkloadIdentityId,
- useActuatorV1Store,
- useDBGroupListByProject,
- useProjectByName,
- useWorkloadIdentityStore,
-} from "@/store";
-import { projectNamePrefix } from "@/store/modules/v1/common";
-import {
- type WorkloadIdentity,
- WorkloadIdentityConfig_ProviderType,
-} from "@/types/proto-es/v1/workload_identity_service_pb";
-import {
- getWorkloadIdentityProviderText,
- parseWorkloadIdentitySubjectPattern,
-} from "@/utils";
-
-const props = defineProps<{
- projectId: string;
-}>();
-
-const actuatorStore = useActuatorV1Store();
-const workloadIdentityStore = useWorkloadIdentityStore();
-
-const projectName = computed(() => `${projectNamePrefix}${props.projectId}`);
-const { project } = useProjectByName(projectName);
-
-const showCreateDrawer = ref(false);
-const selectedIdentityName = ref<string | undefined>(undefined);
-const selectedDatabaseNames = ref<string[]>([]);
-const selectedDatabaseGroupName = ref<string | undefined>(undefined);
-const targetTab = ref<"GROUP" | "DATABASE">("GROUP");
-const activeTab = ref<WorkloadIdentityConfig_ProviderType>(
- WorkloadIdentityConfig_ProviderType.GITHUB
-);
-const useSelfhostRunner = ref(false);
-const showSqlReviewYaml = ref(true);
-const showReleaseYaml = ref(true);
-const showGitlabCiYaml = ref(true);
-
-const { dbGroupList } = useDBGroupListByProject(projectName);
-
-const dbGroupOptions = computed(() => {
- return dbGroupList.value.map((group) => ({
- label: group.title || group.name,
- value: group.name,
- }));
-});
-
-const handleTargetTabChange = (tab: string) => {
- targetTab.value = tab as "GROUP" | "DATABASE";
- if (tab === "GROUP") {
- selectedDatabaseNames.value = [];
- } else {
- selectedDatabaseGroupName.value = undefined;
- }
-};
-
-const hasTargetSelected = computed(() => {
- return targetTab.value === "GROUP"
- ? !!selectedDatabaseGroupName.value
- : selectedDatabaseNames.value.length > 0;
-});
-
-const selectedIdentity = computed(() => {
- if (!selectedIdentityName.value) return undefined;
- return workloadIdentityStore.getWorkloadIdentity(selectedIdentityName.value);
-});
-
-const selectedConfig = computed(
- () => selectedIdentity.value?.workloadIdentityConfig
-);
-
-watch(
- () => selectedConfig.value,
- (config) => {
- activeTab.value =
- config?.providerType ?? WorkloadIdentityConfig_ProviderType.GITHUB;
- }
-);
-
-const parsedSubject = computed(() => {
- if (!selectedIdentity.value) {
- return;
- }
- return parseWorkloadIdentitySubjectPattern(selectedIdentity.value);
-});
-
-// Build a clickable repository URL from the identity.
-const repoUrl = computed(() => {
- const parsed = parsedSubject.value;
- if (!parsed?.owner || !parsed.repo) return "";
-
- const providerType = selectedConfig.value?.providerType;
- if (providerType === WorkloadIdentityConfig_ProviderType.GITHUB) {
- return `https://github.com/${parsed.owner}/${parsed.repo}`;
- }
- if (providerType === WorkloadIdentityConfig_ProviderType.GITLAB) {
- const issuer = selectedConfig.value?.issuerUrl ?? "https://gitlab.com";
- const base = issuer.replace(/\/$/, "");
- return `${base}/${parsed.owner}/${parsed.repo}`;
- }
- return "";
-});
-
-// Branch from the identity, fallback to "main".
-const branch = computed(() => parsedSubject.value?.branch || "main");
-
-const bytebaseUrl = computed(() => {
- const url = actuatorStore.serverInfo?.externalUrl ?? "";
- return url.replace(/\/$/, "");
-});
-
-const workloadIdentityEmail = computed(() => {
- if (!selectedIdentityName.value) {
- return "{WORKLOAD_IDENTITY_EMAIL}";
- }
- return extractWorkloadIdentityId(selectedIdentityName.value);
-});
-
-const targetsString = computed(() => {
- if (targetTab.value === "GROUP" && selectedDatabaseGroupName.value) {
- return selectedDatabaseGroupName.value;
- }
- if (selectedDatabaseNames.value.length === 0) {
- return "";
- }
- return selectedDatabaseNames.value.join(",");
-});
-
-const targetsPlaceholder = computed(() => {
- return targetsString.value || "instances/{instance}/databases/{database}";
-});
-
-const runsOn = computed(() => {
- return useSelfhostRunner.value ? "self-hosted" : "ubuntu-latest";
-});
-
-const sampleFilePath = "migrations/20240101000000_create_sample_table.sql";
-
-const sampleSql = `CREATE TABLE sample (
- id SERIAL PRIMARY KEY,
- name VARCHAR(255) NOT NULL,
- created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
-);`;
-
-const githubSqlReviewYaml = computed(() => {
- return `name: SQL Review
-on:
- pull_request:
- branches: ["${branch.value}"]
- paths: ["migrations/*.sql"]
-jobs:
- sql-review:
- permissions:
- id-token: write
- pull-requests: write
- runs-on: ${runsOn.value}
- container:
- image: bytebase/bytebase-action
- env:
- BYTEBASE_URL: ${bytebaseUrl.value}
- BYTEBASE_WORKLOAD_IDENTITY: ${workloadIdentityEmail.value}
- steps:
- - uses: actions/checkout@v4
- - name: Exchange token
- id: bytebase-auth
- run: |
- OIDC_TOKEN=$(curl -s -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" \\
- "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=bytebase" | jq -r '.value')
- ACCESS_TOKEN=$(curl -s -X POST "$BYTEBASE_URL/v1/auth:exchangeToken" \\
- -H "Content-Type: application/json" \\
- -d "{\\"token\\":\\"$OIDC_TOKEN\\",\\"email\\":\\"$BYTEBASE_WORKLOAD_IDENTITY\\"}" \\
- | jq -r '.accessToken')
- echo "access-token=$ACCESS_TOKEN" >> $GITHUB_OUTPUT
- - name: SQL Review
- env:
- GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
- run: |
- bytebase-action check \\
- --url=$BYTEBASE_URL \\
- --access-token=\${{ steps.bytebase-auth.outputs.access-token }} \\
- --project=projects/${props.projectId} \\
- --targets=${targetsPlaceholder.value} \\
- --file-pattern=migrations/*.sql`;
-});
-
-const exchangeTokenStep = ` - name: Exchange token
- id: bytebase-auth
- run: |
- OIDC_TOKEN=$(curl -s -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" \\
- "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=bytebase" | jq -r '.value')
- ACCESS_TOKEN=$(curl -s -X POST "$BYTEBASE_URL/v1/auth:exchangeToken" \\
- -H "Content-Type: application/json" \\
- -d "{\\"token\\":\\"$OIDC_TOKEN\\",\\"email\\":\\"$BYTEBASE_WORKLOAD_IDENTITY\\"}" \\
- | jq -r '.accessToken')
- echo "access-token=$ACCESS_TOKEN" >> $GITHUB_OUTPUT`;
-
-const accessTokenFlag =
- "--access-token=${{ steps.bytebase-auth.outputs.access-token }}";
-
-const githubReleaseYaml = computed(() => {
- return `name: Rollout
-on:
- push:
- branches: ["${branch.value}"]
- paths: ["migrations/*.sql"]
-env:
- BYTEBASE_URL: ${bytebaseUrl.value}
- BYTEBASE_WORKLOAD_IDENTITY: ${workloadIdentityEmail.value}
- BYTEBASE_PROJECT: projects/${props.projectId}
-jobs:
- build:
- runs-on: ${runsOn.value}
- steps:
- - uses: actions/checkout@v4
- - name: Build
- run: echo "Building..."
- create-rollout:
- needs: build
- permissions:
- id-token: write
- runs-on: ${runsOn.value}
- container:
- image: bytebase/bytebase-action
- outputs:
- bytebase-plan: \${{ steps.set-output.outputs.plan }}
- steps:
- - uses: actions/checkout@v4
-${exchangeTokenStep}
- - name: Create rollout
- run: |
- bytebase-action rollout \\
- --url=$BYTEBASE_URL \\
- ${accessTokenFlag} \\
- --project=$BYTEBASE_PROJECT \\
- --targets=${targetsPlaceholder.value} \\
- --file-pattern=migrations/*.sql \\
- --output=\${{ runner.temp }}/bytebase-metadata.json
- - name: Set output
- id: set-output
- run: |
- PLAN=$(jq -r .plan \${{ runner.temp }}/bytebase-metadata.json)
- echo "plan=$PLAN" >> $GITHUB_OUTPUT
- deploy-to-test:
- needs: create-rollout
- permissions:
- id-token: write
- runs-on: ${runsOn.value}
- environment: test
- container:
- image: bytebase/bytebase-action
- steps:
- - uses: actions/checkout@v4
-${exchangeTokenStep}
- - name: Deploy to test
- run: |
- bytebase-action rollout \\
- --url=$BYTEBASE_URL \\
- ${accessTokenFlag} \\
- --project=$BYTEBASE_PROJECT \\
- --target-stage=environments/test \\
- --plan=\${{ needs.create-rollout.outputs.bytebase-plan }}
- deploy-to-prod:
- needs: [deploy-to-test, create-rollout]
- permissions:
- id-token: write
- runs-on: ${runsOn.value}
- environment: prod
- container:
- image: bytebase/bytebase-action
- steps:
- - uses: actions/checkout@v4
-${exchangeTokenStep}
- - name: Deploy to prod
- run: |
- bytebase-action rollout \\
- --url=$BYTEBASE_URL \\
- ${accessTokenFlag} \\
- --project=$BYTEBASE_PROJECT \\
- --target-stage=environments/prod \\
- --plan=\${{ needs.create-rollout.outputs.bytebase-plan }}`;
-});
-
-const gitlabExchangeScript = ` - |
- ACCESS_TOKEN=$(curl -s -X POST "$BYTEBASE_URL/v1/auth:exchangeToken" \\
- -H "Content-Type: application/json" \\
- -d "{\\"token\\":\\"$GITLAB_OIDC_TOKEN\\",\\"email\\":\\"$BYTEBASE_WORKLOAD_IDENTITY\\"}" \\
- | jq -r '.accessToken')
- export BYTEBASE_ACCESS_TOKEN=$ACCESS_TOKEN`;
-
-const gitlabCiYaml = computed(() => {
- return `stages:
- - sql-review
- - create-rollout
- - deploy-to-test
- - deploy-to-prod
-
-variables:
- BYTEBASE_URL: ${bytebaseUrl.value}
- BYTEBASE_WORKLOAD_IDENTITY: ${workloadIdentityEmail.value}
- BYTEBASE_PROJECT: projects/${props.projectId}
- BYTEBASE_TARGETS: ${targetsPlaceholder.value}
- FILE_PATTERN: "migrations/*.sql"
-
-sql-review:
- stage: sql-review
- image: bytebase/bytebase-action
- id_tokens:
- GITLAB_OIDC_TOKEN:
- aud: bytebase
- rules:
- - if: $CI_PIPELINE_SOURCE == "merge_request_event"
- script:
-${gitlabExchangeScript}
- - bytebase-action check --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --targets=$BYTEBASE_TARGETS --file-pattern=$FILE_PATTERN
-
-create-rollout:
- stage: create-rollout
- image: bytebase/bytebase-action
- id_tokens:
- GITLAB_OIDC_TOKEN:
- aud: bytebase
- rules:
- - if: $CI_COMMIT_BRANCH == "${branch.value}"
- script:
-${gitlabExchangeScript}
- - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --targets=$BYTEBASE_TARGETS --file-pattern=$FILE_PATTERN --output=bytebase-metadata.json
- artifacts:
- paths: [bytebase-metadata.json]
-
-deploy-to-test:
- stage: deploy-to-test
- image: bytebase/bytebase-action
- needs: [create-rollout]
- id_tokens:
- GITLAB_OIDC_TOKEN:
- aud: bytebase
- rules:
- - if: $CI_COMMIT_BRANCH == "${branch.value}"
- environment: test
- script:
-${gitlabExchangeScript}
- - PLAN=$(jq -r .plan bytebase-metadata.json)
- - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --target-stage=environments/test --plan=$PLAN
-
-deploy-to-prod:
- stage: deploy-to-prod
- image: bytebase/bytebase-action
- needs: [deploy-to-test]
- id_tokens:
- GITLAB_OIDC_TOKEN:
- aud: bytebase
- rules:
- - if: $CI_COMMIT_BRANCH == "${branch.value}"
- environment: prod
- when: manual
- script:
-${gitlabExchangeScript}
- - PLAN=$(jq -r .plan bytebase-metadata.json)
- - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --target-stage=environments/prod --plan=$PLAN`;
-});
-
-const handleWorkloadIdentityCreated = (wi: WorkloadIdentity) => {
- selectedIdentityName.value = wi.name;
-};
-</script>
-
-<style scoped>
-.gitops-vcs-tabs :deep(.n-tabs-tab) {
- width: 140px;
- justify-content: center;
-}
-</style>