diff --git a/docs/features/kubernetes/troubleshooting.md b/docs/features/kubernetes/troubleshooting.md index 7b80f3e5a4..a097f3791f 100644 --- a/docs/features/kubernetes/troubleshooting.md +++ b/docs/features/kubernetes/troubleshooting.md @@ -41,11 +41,11 @@ The curl response should have resources from Kubernetes: "metadata": { "creationTimestamp": "2022-03-13T13:52:46.000Z", "labels": { - "app": , + "app": , "backstage": , "backstage.io/kubernetes-id": }, - "name": , + "name": , "namespace": }, .... @@ -73,21 +73,24 @@ recommend you for adding two labels and using label selector annotations: `backstage: ` and `backstage.io/kubernetes-id: `. +`backstage: ` for matching with catalog-info.yaml + +`backstage.io/kubernetes-id: `for get k8s service-related +objects. [link](https://github.com/backstage/backstage/blob/a1f587c/plugins/kubernetes-backend/src/service/KubernetesFetcher.ts#L119) + ```yaml # k8s related yaml (service.yaml, deployment.yaml, ingress.yaml) metadata: - { - creationTimestamp: '2022-03-13T13:52:46.000Z', + creationTimestamp: '2022-03-13T13:52:46.000Z' labels: - { - 'app': , - 'backstage': , - 'backstage.io/kubernetes-id': , - }, - 'name': , - 'namespace': , - } + app: + backstage: + backstage.io/kubernetes-id: + name: + namespace: ``` +k8s-app-name and service-entity-name could be different, but if you would like +to have consistent names between k8s and backstage, we recommend use same name. and the catalog info annotations would use label selector: