Bỏ qua để đến nội dung

Chuyển hoặc copy config

Export config của installation Orbit của bạn, hoặc của một project, ra một file, rồi import file đó ở nơi khác, để không phải setup lại config bằng tay.

System Admin. Chỉ System Admin mới export hoặc import được, và chỉ khi authenticator đã được verify trong session hiện tại.

Dùng tính năng này khi bạn:

  • Chuyển Orbit sang một installation mới. Export toàn bộ installation, rồi import vào Console mới, còn trống.
  • Copy một project sang installation khác. Export một project, rồi import nó ở đó. Nếu sau đó project chỉ nên tồn tại ở nơi mới, hãy gỡ nó khỏi nơi cũ (xem Gỡ một project hoặc một environment).
  • Tạo một bản copy để demo. Export một project, ví dụ toolshop-retail, rồi import nó dưới một tên mới như orbit-demo, trong cùng installation hoặc trong một installation dùng để demo.

Lịch sử run không bao giờ được chuyển. Nơi mới bắt đầu không có run nào và không có kết quả nào.

  • Một account System Admin đã setup authenticator, trên cả Console nguồn và Console đích. Nếu một trang báo “Verify your authenticator first”, chọn Verify now, nhập mã rồi quay lại.
  • Ở installation đích, những người sẽ nhận invite phải nhận được email.
  • Quyết định xem bạn có cần giá trị của các secret hay không (xem Secret và passphrase). Nếu có, chuẩn bị một passphrase ít nhất 16 ký tự và một nơi an toàn để giữ nó.
  • Chỉ import file từ một installation bạn tin cậy. Những người trong file giữ nguyên system role của họ, nên một file có thể tạo ra System Admin.

Trang này là Admin, System, Configuration transfer. Trang có ba phần: Export, Import và Past imports.

Một file (dạng .zip) chứa config: những gì bạn đã setup, không phải những gì đã xảy ra.

Có trong file Không bao giờ có trong file
Khách hàng, project và các quality setting của project Run, kết quả, attempt và file kết quả (trace, screenshot, video)
Team, cùng member và project role của team Test catalog, triage, failure group và quarantine
User: tên, email, system role, expiry của account, chức danh, phòng ban, múi giờ, ngôn ngữ Release, cycle, decision, approval, evidence và risk
Environment Requirement (có chức năng import CSV riêng)
Workload (repo), cùng các environment và nhu cầu account của chúng Report, report snapshot và link chia sẻ
Variable và các giá trị override của profile (chỉ version hiện tại) Investigation, chẩn đoán AI và các cuộc trò chuyện với copilot
Secret: luôn có tên, chỉ có giá trị khi được yêu cầu Audit log và số liệu sử dụng
Test account (password là một secret) Station, site và enrollment code của Station
Run grant trên environment bị hạn chế Session đăng nhập và password
Gate policy của project, template checklist release, lịch gửi report Announcement, setting cá nhân, notification preference và saved view
Setup Jira và kênh Teams cùng notification rule của chúng Các revision của workload (được lấy lại từ repo)
System policy: giao diện, quy tắc authenticator, Station policy, setting và provider AI, setting email (chỉ khi scope là toàn installation) Các version cũ của variable và secret

Các mục đã archive giữ nguyên trạng thái archive. Lịch gửi report giữ nguyên trạng thái tạm dừng. Gate policy và lịch gửi report gắn với một release thì ở lại cùng release đó.

Trong What to export, bạn chọn:

  • Whole installation: mọi khách hàng, project, team và user, cùng các system policy. Dùng để chuyển sang installation mới.
  • One project: một project cùng khách hàng, environment, workload, config, và những user và team mà project dùng. Các team đó là team của chính project, các team tạo thủ công có role trên project, và các team là owner của workload của project. Các project khác của những team này không có trong file. Dùng để copy một project hoặc tạo bản copy để demo.

Bạn cũng có thể bắt đầu export một project từ chính project đó: mở Project settings, Overview và chọn Export configuration…. Trang mở ra với One project và project đó đã được chọn sẵn.

Mặc định, file chỉ chứa tên secret, không có giá trị. Sau khi import, Orbit liệt kê những gì còn thiếu và bạn nhập lại các giá trị.

Đánh dấu Include secret values để mang theo giá trị. Lựa chọn này gồm secret của environment, của repo và của test account, token Jira, webhook URL của Teams, key của AI provider và password email.

Quy tắc về passphrase:

  • Ít nhất 16 ký tự. Gõ vào Passphrase và gõ lại vào Passphrase again.
  • Các giá trị được mã hóa bằng passphrase này bên trong file. Ai có file và passphrase đều đọc được chúng.
  • Orbit không giữ passphrase. Không có nó, không ai đọc được các secret trong file, và không ai khôi phục được chúng.
  • Khi import, Orbit hỏi passphrase để preview và để apply. Nếu passphrase sai, không có gì được ghi.
  • Không bao giờ gửi passphrase cùng với file. Dùng một kênh khác, ví dụ đọc qua điện thoại.

Dùng giá trị khi bạn chuyển một installation thật có nhiều secret. Chỉ dùng tên khi tạo bản copy để demo, hoặc khi installation đích cần secret riêng.

  1. Mở Admin, System, Configuration transfer.
  2. Trong Export, chọn What to export: Whole installation hoặc One project. Với một project, chọn nó trong Project.
  3. Để tắt Include secret values, hoặc đánh dấu nó và điền Passphrase và Passphrase again.
  4. Đọc khung What the file contains. Khung này liệt kê bằng lời đơn giản những gì sẽ có trong file.
  5. Chọn Export configuration.
  6. Kết quả hiển thị tên file (orbit-config-<installation or project>-<date>.zip), dung lượng, scope và số lượng theo từng loại. Chọn Download ngay.
  7. Chọn Done.

Link download chỉ hiển thị một lần và dùng được trong 1 giờ. File nằm trên server trong 10 giờ, sau đó Orbit xóa nó. Mỗi lần export được ghi vào Admin, System, Audit log, kèm thông tin có gồm secret hay không. Passphrase không bao giờ được ghi ở đâu cả.

Admin, System, Configuration transfer: phần Export với One project, danh sách Project, Include secret values và What the file contains

File chứa email của mọi người và setup của các project. Khi có giá trị secret, file cũng chứa các giá trị đó, ở dạng đã mã hóa.

  • Chỉ để file ở nơi mà người được phép xem mới truy cập được, ví dụ một folder được bảo vệ. Không để trong group chat chung hay một ticket.
  • Giữ passphrase tách riêng khỏi file.
  • Khi import đã xong và đã được kiểm tra, xóa file. Làm trống cả thùng rác, và xóa các bản copy trong email hoặc folder Downloads.

Làm việc này trên Console đích: installation mới, hoặc chính installation đó nếu là bản copy.

  1. Mở Admin, System, Configuration transfer.
  2. Trong Import, chọn file ở Export file (.zip, at most 10 MB).
  3. File được upload theo từng phần, có progress bar. Khi xong, trang hiển thị scope, ai đã export và khi nào, version Orbit đã tạo ra file, các secret của file và số lượng theo từng loại.
  1. Nếu file có giá trị secret, nhập Passphrase of the secrets.
  2. Chọn Preview the import. Chưa có gì được ghi.
  3. Plan hiện ra, nhóm theo loại (System policies, Customers, People, Teams, Projects, Environments, Workloads và các loại khác). Mỗi mục có một action:
Action Ý nghĩa
Create Mục này chưa có ở đây và sẽ được tạo.
Reuse Mục này đã có ở đây và được giữ nguyên. Ví dụ một khách hàng có cùng tên ngắn, một user có cùng email, một system policy đã được đặt.
Conflict Slug của mục này đã được dùng ở đây. Bạn quyết định: đổi tên hoặc bỏ qua.
Skip Mục này sẽ không được tạo. Dòng của nó cho biết lý do.

Các nhóm có conflict, cùng các nhóm People và System policies, tự mở ra. Đọc nhóm People trước khi apply: mỗi user mới hiển thị system role mà họ sẽ nhận (Member hoặc System Admin). User đã có account hiển thị “existing account: keeps its role”.

Chỉ có thể tạo mới. Import không bao giờ thay đổi hay ghi đè những gì đã có ở đây.

  • Đổi tên. Project và team tạo thủ công có slug đã bị dùng thì đổi tên được. Điền New slug (các từ viết thường nối bằng dấu gạch ngang, 2 đến 50 ký tự) và New name. Mọi thứ thuộc về mục đó đi theo tên mới.
  • Bỏ qua. Chọn Skip trên mục đó. Những gì phụ thuộc vào nó cũng bị bỏ qua; dòng của chúng ghi, ví dụ, “Skipped with projects “toolshop-retail”, which it needs.” Chọn Include để hoàn tác. Bạn cũng có thể bỏ qua các mục Create mà bạn không muốn.
  • Một số mục không đổi tên được: “This one cannot be renamed: skip it to go on.”

Sau mỗi thay đổi, chọn Preview again. Apply bị khóa cho đến khi plan khớp với các quyết định của bạn và mọi conflict đều đã được trả lời.

Những điều plan tự quyết định:

  • Workload. Một repo chỉ dùng được cho một workload trong một installation. Khi installation này đã có một workload trên cùng repo, hoặc có cùng slug, workload đó bị bỏ qua. Vì vậy, một bản copy project trong cùng installation nhận được environment, variable và test account, nhưng không nhận workload, cũng không nhận những gì thuộc về workload (variable của repo, giá trị override của profile, secret của repo).
  • Secret không có giá trị. Với file chỉ có tên, mọi secret hiển thị Skip: “The file has no value for this secret, so it is not written. Enter it again after importing.”
  • Lịch gửi report mà mọi environment của nó đều bị bỏ ra sẽ bị bỏ qua, để lịch đó không chuyển thành report trên mọi environment.
  • Team của project. Các managed team của một project (Viewer, QA Engineer, QA Lead, Project Admin) được tạo lại cho project mới, cùng member của chúng.
  • System policy đã có ở đây được giữ nguyên. Nhóm System policies hiển thị quy tắc authenticator của cả hai bên, ví dụ “MFA required: source yes, here no”.
  1. Chọn Apply. Hộp thoại “Apply this import?” cho biết sẽ tạo bao nhiêu mục. Chọn Apply import.
  2. Một progress bar và danh sách các loại cho thấy phần nào đã xong. Để trang mở.
  3. Orbit làm theo từng bước ngắn và tự tiếp tục cho đến khi import ở trạng thái Done.

Nếu trang bị đóng, mạng bị ngắt hoặc server dừng giữa chừng, không có gì bị mất. Những gì đã được tạo vẫn còn. Mở import đó trong Past imports, rồi chọn Continue applying. Import tiếp tục với các quyết định từ lần preview trước. Nếu file còn giá trị secret chưa được ghi, nhập lại passphrase.

Khi kết thúc, một bảng hiển thị theo từng loại những gì đã Created, Reused và Skipped (và Of which renamed khi bạn đã đổi tên một mục), tiếp theo là checklist After importing.

Mỗi lần import được ghi vào Admin, System, Audit log, và mỗi mục được tạo cũng vậy.

User chưa có ở đây được tạo không gửi email và không có password. Không ai nhận email trong lúc import, để bạn hoàn tất installation mới trước. Họ không đăng nhập được cho đến khi bạn gửi invite.

  • Trên Admin, People and access, Users, họ hiển thị Not invited yet. Đánh dấu Not invited yet (…) để chỉ liệt kê những user này.
  • Chọn Send invite trên một dòng để invite một người.
  • Chọn Send invites to all not invited, rồi Send invites, để invite tất cả. Mỗi người nhận một email để đặt password.
  • Nếu có invite gửi không được, trang báo “Some invites were not sent”. Những người đó vẫn nằm trong Not invited yet: gửi lại sau, hoặc gửi từng người.
  • Danh sách user của project cũng đánh dấu họ là Not invited yet.

Họ giữ system role, expiry của account và trạng thái như trong file. Account đã quá expiry thì ở đây cũng hết hạn: gia hạn trên Users. User đã bị disable được import ở trạng thái disable và không có nút Send invite. System Admin được import phải setup authenticator ở lần đăng nhập đầu tiên, khi quy tắc authenticator đang bật.

Phần tóm tắt của một import đã xong kết thúc bằng checklist này. Làm hết trước khi mọi người bắt đầu dùng nơi mới.

  1. Cài GitHub App trên các repo của những workload được import, từ Project settings, Workloads. Như vậy các repo được link lại, và các revision của chúng được lấy lại từ repo.
  2. Enroll các Station sẽ chạy test, từ Admin, Stations. Station thuộc về địa chỉ Console cũ và không bao giờ được chuyển. Xem Cài đặt Orbit Station.
  3. Nhập các secret còn thiếu từ readiness checklist của từng project (Project settings, Overview), cùng key của AI provider và password email trên Admin, System, AI và Email.
  4. Bật Jira và Teams trên Project settings, Integrations sau khi nhập credential của chúng. Jira không có token và kênh Teams không có webhook URL được import ở trạng thái tắt. Kênh Teams mà mọi workload của nó đều bị bỏ ra cũng được import ở trạng thái tắt.
  5. Gửi invite (xem ở trên). Checklist có link tới People not invited yet.
  6. Kiểm tra setting authenticator. Các system policy đã có ở đây được giữ nguyên, không bị thay bằng policy trong file. Installation mới luôn có sẵn setting authenticator, nên setting trong file không bao giờ được copy: kiểm tra trên Admin, System, Security (Authenticator code, Turn on hoặc Turn off).

Sau đó chạy một test đầu tiên trên mỗi project, như trong Onboard project của khách hàng vào Orbit.

Giới hạn Giá trị
Link download của một bản export Hiển thị một lần, dùng được 1 giờ
File export được giữ trên server 10 giờ
Dung lượng file bạn import Tối đa 10 MB
File upload chưa xong Bị xóa sau 10 giờ; upload lại
Passphrase Ít nhất 16 ký tự
Merge hoặc cập nhật các mục đã có Không được: chỉ tạo mới
Tự động rollback Không có. Bước preview là lớp bảo vệ.
Lịch sử run, kết quả, file kết quả, audit log Không bao giờ được chuyển
File từ một version Orbit mới hơn Bị từ chối cho đến khi installation đích được cập nhật

Một config thực tế nhỏ hơn rất nhiều so với các giới hạn này. Nếu một bản export bị từ chối vì quá lớn, export từng project một.

Bạn thấy Lý do Cần làm gì
“Verify your authenticator first” Configuration transfer cần mã authenticator trong session này. Chọn Verify now, nhập mã, rồi quay lại.
“Only System Admins can transfer configuration.” Account của bạn là Member. Nhờ một System Admin.
“Use at least 16 characters (… so far).” hoặc “The two passphrases do not match.” Passphrase quá ngắn, hoặc hai ô không giống nhau. Gõ passphrase dài hơn, giống nhau ở cả hai ô.
Link download không dùng được Link chỉ hiển thị một lần và dùng được 1 giờ; file bị xóa sau 10 giờ. Export lại.
“Choose the .zip file an Orbit export produced.” File đã chọn không phải .zip. Chọn file export đã download.
“The file is larger than 10 MB, the most an import takes.” File quá lớn. Export từng project một.
“This file is not an Orbit configuration export, or it is damaged.” File không phải bản export, hoặc đã bị thay đổi. Download lại file export. Không sửa file.
“This file comes from a newer Orbit. Update this installation, then import it again.” Installation nguồn chạy version Orbit mới hơn installation đích. Cập nhật installation đích, rồi import lại.
“The configuration is too large to export or import in one file.” Config rất lớn. Export từng project một.
“The passphrase does not open the secrets of this file. Nothing was written.” Sai passphrase. Nhập passphrase đã chọn khi export. Nếu đã mất, export lại, với passphrase mới hoặc không kèm giá trị.
“Your decisions changed since the preview. Preview again before you apply.” Bạn đã đổi tên hoặc bỏ qua một mục sau lần preview gần nhất. Chọn Preview again.
“2 conflicts still need a new slug and name, or a skip.” Một số conflict chưa được trả lời. Đổi tên hoặc bỏ qua từng conflict.
“Nothing would be created.” Mọi mục đều được reuse hoặc bị bỏ qua. Không cần làm gì; config đã có ở đây.
“The new slug is taken here or by another item of the file. Choose another one.” Slug mới cũng đã bị dùng. Chọn slug khác.
“Something was created here since the preview and now conflicts. Preview again.” Ai đó đã tạo một mục có cùng slug sau lần preview của bạn. Chọn Preview again và quyết định conflict mới.
“This import is already being applied elsewhere. Wait a minute, then continue applying.” Import đang chạy ở một tab khác hoặc do một admin khác. Chờ, rồi chọn Continue applying.
“The import stopped part-way. What it created stays. Continue applying to create the rest.” Server dừng giữa chừng. Chọn Continue applying.
“The sign-in service did not answer while creating accounts. What was created stays. Continue applying to go on.” Dịch vụ đăng nhập không trả lời trong lúc tạo user. Chọn Continue applying sau một lát.
“This Console cannot create accounts right now: …” Console đích chưa được setup để tạo account. Hỏi người vận hành installation Orbit của bạn.
“The uploaded file was removed after 10 hours. Upload it again.” File upload đã quá 10 giờ khi bạn tiếp tục. Chọn Import another file và upload lại.
“Part of the upload did not arrive.” hoặc “The upload does not match the size of the file.” Upload bị gián đoạn. Upload file lại.
“The import failed” Một mục không tạo được. Dòng của nó cho biết lý do. Những gì đã tạo trước đó vẫn còn. Kiểm tra chúng, hoặc xóa thủ công. Rồi import lại: những gì đã có sẽ được reuse hoặc báo conflict.
Một workload bị thiếu sau khi copy Repo của nó đã được một workload ở đây sử dụng. Đây là điều bình thường trong cùng một installation. Copy sang installation khác nếu bạn cần cả workload.
User không đăng nhập được Họ được tạo mà chưa có invite. Gửi invite (xem ở trên).
Jira hoặc Teams không gửi gì Chúng được import ở trạng thái tắt. Nhập credential và bật chúng trên Project settings, Integrations.
Key Tìm ở đâu Lưu giữ
Passphrase của các secret Bạn tự chọn khi export Bí mật. Chỉ thấy một lần (Orbit không bao giờ hiển thị hay giữ nó). Giữ trong password manager, tách riêng khỏi file, cho đến khi import đã được kiểm tra.
Tên file export Kết quả export, và file đã download Không bí mật, nhưng file chứa email (và secret đã mã hóa): xóa file sau khi dùng
Import, trạng thái và phần tóm tắt của nó Admin, System, Configuration transfer, Past imports Không bí mật
Các slug và tên mới bạn đã chọn Plan, và phần tóm tắt (Of which renamed) Không bí mật. Bạn cần chúng trong manifest (team:) và khi báo cho mọi người bản copy nằm ở đâu.