diff --git a/docs/guides/all/import-and-manage-integration.md b/docs/guides/all/import-and-manage-integration.md index 04c1df228..46d9a6ab9 100644 --- a/docs/guides/all/import-and-manage-integration.md +++ b/docs/guides/all/import-and-manage-integration.md @@ -18,7 +18,8 @@ In this example we'll use the Import State feature of Terraform, then manage our ## Prerequisites -You will need to create an integration within the Port UI, For example the [Kubernetes Exporter](/guides/all/visualize-service-k8s-runtime) +You will need to create an integration within the Port UI, For example the [Kubernetes Exporter](/guides/all/visualize-service-k8s-runtime +) :::note Installation Id As you create the integration, take note of the installation Id. diff --git a/docs/guides/all/manage-resources-using-k8s-crds.md b/docs/guides/all/manage-resources-using-k8s-crds.md index d1040a000..31e33d1ad 100644 --- a/docs/guides/all/manage-resources-using-k8s-crds.md +++ b/docs/guides/all/manage-resources-using-k8s-crds.md @@ -164,7 +164,7 @@ By leveraging the power of the K8s API extensions, platform engineers can keep u ### Next Steps -- Enrich the catalog and visualize the Runtime existing objects in your K8s cluster, by following the [Visualize services' k8s runtime guide](./visualize-service-k8s-runtime.md). +- Enrich the catalog and visualize the Runtime existing objects in your K8s cluster, by following the [Visualize services' k8s runtime guide](./visualize-service-k8s-runtime). - Port allows multiple ways to enhance the experience of executing `Actions`, feel free to alter the `Action` in Port to your needs by visiting [Action Documentation](/actions-and-automations/create-self-service-experiences/create-self-service-experiences.md). - [Sync data](/build-your-software-catalog/sync-data-to-catalog/sync-data-to-catalog.md) and create more `Blueprints` to enrich the data beyond what exists in K8S. - Build dashboards and reports to visualize the usage of the CRDs and resources in your K8s cluster by following the [Build dashboards and reports guide](/customize-pages-dashboards-and-plugins/dashboards/dashboards.md). \ No newline at end of file diff --git a/docs/guides/all/visualize-service-k8s-runtime.md b/docs/guides/all/visualize-service-k8s-runtime.md index 64695827a..c64467974 100644 --- a/docs/guides/all/visualize-service-k8s-runtime.md +++ b/docs/guides/all/visualize-service-k8s-runtime.md @@ -1,5 +1,4 @@ --- -sidebar_position: 4 displayed_sidebar: null description: Learn how to visualize Kubernetes service runtime in Port, improving monitoring and management of your cloud-native applications. --- @@ -11,30 +10,30 @@ import PortApiRegionTip from "/docs/generalTemplates/_port_region_parameter_expl # Visualize your services' k8s runtime -This guide takes 10 minutes to complete, and aims to demonstrate the value of Port's integration with Kubernetes. +Port’s Kubernetes integration helps you easily model and visualize your cluster’s workloads alongside your existing services in Port. Once implemented: +- Developers can quickly see the health and status of their services’ K8s runtime. +- Platform engineers can create custom views and dashboards for different stakeholders. +- R&D managers can track data about services’ K8s resources, enabling high-level oversight and better decision-making. -:::info Prerequisites +## Common use cases -- This guide assumes you have a Port account and that you have finished the [onboarding process](/quickstart). We will use the `Service` blueprint that was created during the onboarding process. -- You will need an accessible k8s cluster. If you don't have one, here is how to quickly set-up a [minikube cluster](https://minikube.sigs.k8s.io/docs/start/). -- [Helm](https://helm.sh/docs/intro/install/) - required to install Port's Kubernetes exporter. +- Unified Observability: Bring your `Service` blueprint and Kubernetes workloads together in one catalog. +- Automatic Discovery: Reflect new deployments or changes in K8s as updated entities in Port, no manual steps needed. +- Metrics and Standards: Attach scorecards to K8s resources to ensure best practices (e.g., minimum replicas, correct naming labels). +- Customized Visuals: Build dashboards that highlight critical metrics—like resource usage or availability—tailored to your team’s needs. -::: -
+## Prerequisites -### The goal of this guide +- This guide assumes you have a Port account and that you have finished the [onboarding process](/quickstart). We will use the `Service` blueprint that was created during the onboarding process. +- You will need an accessible k8s cluster. If you don't have one, here is how to quickly set-up a [minikube cluster](https://minikube.sigs.k8s.io/docs/start/). +- [Helm](https://helm.sh/docs/intro/install/) - required to install Port's Kubernetes exporter. -In this guide we will model and visualize our services' Kubernetes resources. -After completing it, you will get a sense of how it can benefit different personas in your organization: +## Set up data model -- Developers will be able to easily view the health and status of their services' K8s runtime. -- Platform engineers will be able to create custom views and visualizations for different stakeholders in the organization. -- Platform engineers will be able to set, maintain and track standards for K8s resources. -- R&D managers will be able to track any data about services' K8s resources, using tailor-made views and dashboards. +To integrate Kubernetes resources with your existing `Service` blueprint, we’ll first install Port’s Kubernetes exporter, which automatically creates Kubernetes-related blueprints and entities in Port. Then we’ll define a relation that ties each `Workload` to the `Service` it belongs to. -
### Install Port's Kubernetes exporter @@ -106,7 +105,8 @@ In this guide we will create one relation named `service` which will represent t

-### Map your workloads to their services + +## Map your workloads to their services You may have noticed that the `service` relations are empty for all of our `workloads`. This is because we haven't specified which `workload` belongs to which `service`. This can be done manually, or via mapping by using a convention of your choice. @@ -159,8 +159,8 @@ spec:
2. To see the new data, we need to update the mapping configuration that the K8s exporter uses to ingest data. -To edit the mapping, go to your [data sources page](https://app.getport.io/settings/data-sources), find the K8s exporter card, click on it and you will see a YAML editor showing the current configuration. -Add the following block to the mapping configuration and click `Resync`: + To edit the mapping, go to your [data sources page](https://app.getport.io/settings/data-sources), find the K8s exporter card, click on it and you will see a YAML editor showing the current configuration. + Add the following block to the mapping configuration and click `Resync`: ```yaml showLineNumbers resources: @@ -189,11 +189,13 @@ resources:

-### Visualize data from your Kubernetes environment +## Visualize data from your Kubernetes environment -We now have a lot of data about our workloads, and some metrics to track their quality. Let's see how we can visualize this information in ways that will benefit the routine of our developers and managers. +We now have a lot of data about our workloads, and some metrics to track their quality. +Let's see how we can visualize this information in ways that will benefit the routine of our developers and managers. +Let's start by creating a few widgets that will help us keep track of our services' health and availability. -#### Add an "Unhealthy services" table to your homepage +### Add an "Unhealthy services" table to your homepage In the configuration provided for this guide, a `workload` is considered `Healthy` if its defined number of replicas is equal to its available replicas (of course, you can change this definition). @@ -217,7 +219,7 @@ Now you can keep track of services that need your attention right from your home _These services were not included in this guide, but serve to show an example of how this table might look._ -#### Use your scorecards to get a clear overview of your workloads' availability +### Use your scorecards to get a clear overview of your workloads' availability In the configuration provided for this guide, the availability metric is defined like this: @@ -243,13 +245,13 @@ To get an overall picture of our workloads' availability, we can use a table ope Note that you can also set this as the default view by click on the `Save this view` button 📝 -### Possible daily routine integrations +## Possible daily routine integrations - Send a slack message in the R&D channel to let everyone know that a new deployment was created. - Notify Devops engineers when a service's availability drops. - Send a weekly/monthly report to R&D managers displaying the health of services' production runtime. -### Conclusion +## Conclusion Kubernetes is a complex environment that requires high-quality observability. Port's Kubernetes integration allows you to easily model and visualize your Kubernetes resources, and integrate them into your daily routine. Customize your views to display the data that matters to you, grouped or filtered by teams, namespaces, or any other criteria.