Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Halaman ini menjelaskan cara menggunakan dasbor Config Sync.
Dasbor ini memberi Anda ringkasan komprehensif tentang paket yang dikelola Config Sync dan status resource dalam paket ini.
Sebelum memulai
Izin IAM
Untuk mengakses dasbor Config Sync, peran IAM berikut diperlukan di project:
roles/container.clusterViewer
roles/gkehub.viewer
Kontrol akses berbasis peran
Pengguna juga memerlukan izin Kubernetes yang relevan di setiap cluster. Jika Anda tidak ingin memberikan izin yang luas kepada pengguna, seperti izin admin cluster, Anda dapat membuat peran RBAC kustom yang mencakup izin minimum yang diperlukan untuk menggunakan dasbor Config Sync.
config-sync-dashboard-readerClusterRole memberikan izin get dan
list kepada pengguna pada resource yang diperlukan oleh dasbor.
Untuk membuat config-sync-dashboard-readerClusterRole dan menerapkannya ke
cluster, jalankan perintah berikut:
Ikuti petunjuk untuk mengonfigurasi role-based access control
di cluster edisi Google Kubernetes Engine (GKE) Enterprise untuk menyiapkan ClusterRoleBinding.
Mengakses dasbor
Di konsol Google Cloud , buka halaman Config di bagian Features.
Tab dasbor memberikan ringkasan status penginstalan Config Sync Anda:
Status rekonsiliasi menunjukkan jumlah paket yang direkonsiliasi. Paket
direkonsiliasi jika status yang Anda inginkan, sebagaimana dinyatakan oleh
resource dalam paket, telah terwujud.
Paket Anda dapat memiliki status rekonsiliasi berikut:
Saat ini: status paket sebenarnya cocok dengan status yang Anda
inginkan. Proses rekonsiliasi dianggap selesai hingga ada perubahan
pada status yang Anda inginkan atau status sebenarnya.
Sedang diproses: status paket sebenarnya belum mencapai
status yang Anda inginkan (seperti yang dinyatakan oleh resource dalam paket).
Paket yang baru dibuat biasanya dimulai dengan status ini.
Gagal: proses mencocokkan status sebenarnya dengan status yang Anda inginkan telah mengalami error atau tidak membuat kemajuan yang memadai.
Tidak diketahui: Config Sync tidak dapat menentukan status rekonsiliasi paket.
Status sinkronisasi menampilkan jumlah paket yang disinkronkan. Paket disinkronkan saat status paket terbaru yang diamati di sumber (misalnya, repositori Git) ditampilkan di cluster.
Paket Anda dapat memiliki status sinkronisasi berikut:
Disinkronkan: paket disinkronkan ke cluster.
Tertunda: paket menunggu sinkronisasi.
Menyesuaikan: Deployment yang menyinkronkan paket sedang
disesuaikan.
Tertunda: Deployment yang menyinkronkan paket tertunda.
Error: paket mengalami error selama sinkronisasi.
Tidak diketahui: Config Sync tidak dapat menentukan status sinkronisasi paket.
Status Config Sync menunjukkan status penginstalan
Config Sync di cluster Anda.
Cluster Anda dapat memiliki status berikut terkait dengan Config Sync:
Diaktifkan: cluster yang telah mengaktifkan Config Sync.
Tidak diaktifkan: cluster yang tidak mengaktifkan Config Sync.
Tertunda: cluster yang telah mengaktifkan Config Sync, tetapi sedang mengalami perubahan. Status ini biasanya terjadi selama konfigurasi
pertama kali atau saat memperbarui ke versi baru.
Error: cluster yang mengaktifkan Config Sync, tetapi ada masalah dan Config Sync tidak berfungsi.
Tidak diketahui: Status Config Sync tidak dapat ditentukan.
Tabel tambahan menampilkan masalah yang dikelompokkan menurut paket dan cluster, menyediakan link
untuk menginstal Config Sync dan melihat setelan, serta resource untuk memulai.
Melihat status paket
Tab Paket memungkinkan Anda melihat detail mendalam tentang setiap paket dan cluster. Gunakan tab ini untuk lebih memahami potensi penyebab di balik
error sinkronisasi dan resource yang tidak sehat.
Mengedit paket
Anda juga dapat menggunakan tab Paket untuk mengedit konfigurasi paket.
Untuk mengedit paket, selesaikan langkah-langkah berikut:
Di samping nama paket yang ingin Anda edit, pilih
edit di kolom Edit paket
Di bagian Detail paket, dari daftar drop-down Jenis sumber,
pilih jenis sumber Anda.
Di bagian Sumber, selesaikan langkah-langkah berikut:
Untuk sumber yang dihosting di repositori Git, masukkan kolom berikut:
Masukkan URL repositori Git yang Anda gunakan sebagai sumber tepercaya
sebagai URL Repositori.
Opsional: Perbarui kolom Revisi untuk melakukan checkout jika Anda tidak menggunakan
HEAD default.
Opsional: Perbarui kolom Path jika Anda tidak ingin menyinkronkan dari
repositori root.
Opsional: Perbarui kolom Branch jika Anda tidak menggunakan cabang main default.
Untuk sumber yang dihosting dalam image OCI, masukkan kolom berikut:
Masukkan URL gambar OCI yang Anda gunakan sebagai sumber kebenaran
sebagai Gambar.
Masukkan jalur direktori yang akan disinkronkan dari,
relatif terhadap direktori root, sebagai Direktori.
(Opsional): Luaskan bagian Advanced settings untuk menyelesaikan langkah-langkah berikut:
Pilih Jenis autentikasi:
Tidak ada: Tidak menggunakan autentikasi.
SSH: Gunakan pasangan kunci SSH.
Cookiefile: Gunakan cookiefile.
Token: Gunakan token.
Google Cloud Repository: Menggunakan akun layanan Google untuk mengakses repositori Cloud Source Repositories. Pilih opsi ini hanya jika Workload Identity Federation untuk GKE tidak diaktifkan di cluster Anda.
Workload Identity: Menggunakan akun layanan Google untuk mengakses repositori Cloud Source Repositories.
Masukkan angka dalam detik untuk menyetel Waktu tunggu sinkronisasi, yang menentukan
berapa lama Config Sync menunggu di antara sinkronisasi dari sumber tepercaya.
Masukkan URL proxy Git untuk proxy HTTPS yang akan digunakan saat
berkomunikasi dengan sumber tepercaya.
Pilih Hierarki untuk mengubah Format sumber.
Nilai default Tidak terstruktur direkomendasikan dalam sebagian besar kasus karena
memungkinkan Anda mengatur sumber tepercaya sesuai keinginan.
Setelah selesai mengedit paket, klik Simpan.
Anda akan dialihkan ke halaman Packages Config Sync. Setelah beberapa menit, Anda akan melihat Disinkronkan di kolom Status sinkronisasi untuk paket yang Anda konfigurasi.
Lihat setelan
Tab Setelan menampilkan daftar cluster, beserta informasi
tentang setelan Config Sync dan setelan grupnya.
Anda juga dapat menggunakan tab ini untuk mengupgrade Config Sync di cluster:
Di samping nama cluster yang ingin Anda upgrade, pilih menu
konteks more_vert, lalu pilih
editEdit Config.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-08-04 UTC."],[],[],null,["# Use the Config Sync dashboard\n\nThis page explains how to use the Config Sync dashboard.\n\nThis dashboard provides you with a comprehensive overview of the packages that\nConfig Sync manages and the status of the resources in these packages.\n| **Key Term:** A *package* contains all of the configs contained in each . Because you can sync your cluster from multiple sources, you might have multiple packages per cluster.\n\nBefore you begin\n----------------\n\n### IAM permissions\n\nTo access the Config Sync dashboard, the following IAM roles are required in\nthe project:\n\n- `roles/container.clusterViewer`\n- `roles/gkehub.viewer`\n\n### Role-based access control\n\nThe user also needs the relevant Kubernetes permissions in each cluster. If you\ndon't want to grant users extensive permissions, such as those of the cluster\nadmin, you can create a custom RBAC role that includes the minimum permissions\nrequired to use the Config Sync dashboard.\n\nThe `config-sync-dashboard-reader` `ClusterRole` grants the user `get` and\n`list` permissions on the resources needed by the dashboard.\n\n1. To create the `config-sync-dashboard-reader` `ClusterRole` and apply it to\n the cluster, run the following command:\n\n cat \u003c\u003cEOF \u003e config-sync-dashboard-reader.yaml\n kind: ClusterRole\n apiVersion: rbac.authorization.k8s.io/v1\n metadata:\n name: config-sync-dashboard-reader\n rules:\n - apiGroups: [\"apiextensions.k8s.io\"]\n resources: [\"customresourcedefinitions\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"configmanagement.gke.io\"]\n resources: [\"configmanagements\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"configsync.gke.io\"]\n resources: [\"rootsyncs\", \"reposyncs\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"kpt.dev\"]\n resources: [\"resourcegroups\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"apps\"]\n resources: [\"deployments\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"\"]\n resources: [\"pods\", \"services\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"anthos.cloud.google.com\"]\n resources: [\"canonicalservices\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"networking.istio.io\"]\n resources: [\"virtualservices\"]\n verbs: [\"get\", \"list\"]\n\n EOF\n kubectl apply -f config-sync-dashboard-reader.yaml\n\n2. Follow the instructions for configuring [role-based access control](https://cloud.google.com/anthos/identity/setup/bearer-token-auth#configure_role-based_access_control)\n on Google Kubernetes Engine (GKE) Enterprise edition clusters to set up the `ClusterRoleBinding`.\n\nAccess the dashboard\n--------------------\n\n1. In the Google Cloud console, go to the **Config** page under the **Features** section.\n\n \u003cbr /\u003e\n\n [Go to Config](https://console.cloud.google.com/kubernetes/config_management)\n2. Select the project that you want to view.\n\nView the dashboard\n------------------\n\nThe **dashboard** tab provides you an overview of the status of your\nConfig Sync installations:\n\n- **Reconciliation status** shows you how many packages are reconciled. A\n package is reconciled if the state that you want, as expressed by the\n resources in the package, has been realized.\n\n Your packages can have the following reconciliation statuses:\n - **Current**: the actual state of the package matches the state that you want. The reconcile process is considered complete until there are changes to either the state you want or the actual state.\n - **In progress**: the actual state of the package hasn't yet reached the state that you want (as expressed by the resources in the package). Newly created packages usually start with this status.\n - **Failed**: the process of reconciling the actual state with the state that you want has encountered an error or it has made insufficient progress.\n - **Unknown**: Config Sync couldn't determine the reconciliation status of a package.\n- **Synchronization status** shows you how many packages are synced. A package\n is synced when the latest observed state of the package in the source (for\n example, a Git repository) is reflected in the cluster.\n\n Your packages can have the following synchronization statuses:\n - **Synced**: the package is synced to a cluster.\n - **Pending**: the package is pending synchronization.\n - **Reconciling**: the Deployment that syncs a package is being reconciled.\n - **Stalled**: the Deployment that syncs a package is stalled.\n - **Error**: the package encountered an error during syncing.\n - **Unknown**: Config Sync couldn't determine the synchronization status of a package.\n- **Config Sync status** shows you the installation status of\n Config Sync on your clusters.\n\n Your clusters can have the following status related to Config Sync:\n - **Enabled**: clusters that have Config Sync enabled.\n - **Not enabled**: clusters that don't have Config Sync enabled.\n - **Pending**: clusters that have Config Sync enabled, but are undergoing changes. This status usually occurs during first-time configuration or when updating to a new version.\n - **Error**: clusters that have Config Sync enabled, but there's an issue and Config Sync isn't working.\n - **Unknown**: Config Sync's status can't be determined.\n\nAdditional tables show you issues grouped by package and cluster, provide links\nto install Config Sync and view settings, and resources for getting started.\n\nView package status\n-------------------\n\nThe **Packages** tab enables you to view in-depth details about individual\npackages and clusters. Use this tab to better understand potential causes behind\nsync errors and unhealthy resources.\n\nEdit a package\n--------------\n\nYou can also use the **Packages** tab to edit your package configurations.\n\nTo edit a package, complete the following steps:\n\n1. Beside the name of the package that you want to edit, select *edit* in the **Edit package** column\n2. In the **Package details** section, from the **Source type** drop-down list, select your source type.\n3. In the **Source** section, complete the following:\n\n - For sources hosted in a Git repository, enter the following fields:\n\n 1. Enter the URL of the Git repository that you're using as a source of truth as the **Repository URL**.\n 2. Optional: Update the **Revision** field to check out if you're not using the default `HEAD`.\n 3. Optional: Update the **Path** field if you don't want to sync from the root repository.\n 4. Optional: Update the **Branch** field if you're not using the default `main` branch.\n - For sources hosted in an OCI image, enter the following fields:\n\n 1. Enter the URL of the OCI image that you're using as a source of truth as the **Image**.\n 2. Enter the path of the directory to sync from, relative to the root directory, as the **Directory**.\n4. (Optional): Expand the **Advanced settings** section to complete the following:\n\n 1. Select an **Authentication type**:\n\n | **Note:** for OCI, you can only select **Workload Identity** for authentication.\n - **None**: Use no authentication.\n - **SSH**: Use an SSH key pair.\n - **Cookiefile** : Use a `cookiefile`.\n - **Token**: Use a token.\n - **Google Cloud Repository** : Use a Google service account to access a Cloud Source Repositories repository. Only select this option if Workload Identity Federation for GKE is *not* enabled in your cluster.\n - **Workload Identity**: Use a Google service account to access a Cloud Source Repositories repository.\n 2. Enter a number in seconds to set the **Sync wait time**, which determines\n how long Config Sync waits between syncing from the source of truth.\n\n 3. Enter a **Git proxy** URL for the HTTPS proxy to be used when\n communicating with the source of truth.\n\n 4. Choose **Hierarchy** to change the **Source format**.\n\n The default value **Unstructured** is recommended in most cases since it\n lets you organize your source of truth however you want.\n5. When you are finished editing your package, click **Save**.\n\n You are redirected to the Config Sync **Packages** page. After a few minutes, you should see **Synced** in the **Sync status**\n column for the package that you configured.\n\nView settings\n-------------\n\nThe **Settings** tab shows you a list of clusters, along with information\nabout their Config Sync settings and fleet settings.\n\nYou can also use this tab to upgrade Config Sync on a cluster:\n\n- Beside the name of the cluster that you want to upgrade, select the context menu *more_vert* and then select *edit* **Edit Config**.\n\nFor guidance on Config Sync settings, see [Configure Config Sync](/kubernetes-engine/enterprise/config-sync/docs/how-to/installing-config-sync#configuring-config-sync).\n\nWhat's next\n-----------\n\n- Learn about [using the Google Cloud CLI](/kubernetes-engine/enterprise/config-sync/docs/how-to/config-sync-status-gcloud) to monitor Config Sync.\n- Learn about [using the nomos command-line tool](/kubernetes-engine/enterprise/config-sync/docs/how-to/nomos-command) to monitor Config Sync.\n- Learn how to [Monitor Config Sync with\n metrics](/kubernetes-engine/enterprise/config-sync/docs/how-to/monitoring-config-sync)."]]
