From 308627cdf3a8f5ae45a025dc31d597369395ba15 Mon Sep 17 00:00:00 2001 From: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> Date: Thu, 10 Oct 2024 12:26:38 -0700 Subject: [PATCH] docs: pxk-license (#4258) * docs: pxk-license * docs: Apply suggestions from code review Co-authored-by: caroldelwing * docs: Apply suggestions from code review Co-authored-by: caroldelwing * ci: auto-formatting prettier issues --------- Co-authored-by: caroldelwing Co-authored-by: karl-cardenas-coding (cherry picked from commit 200ba1fd740aa69627324376c1aba5df89d48c74) --- .../oss-licenses-index/pxk-oss-licenses.md | 55 ++++++++++++++++++- 1 file changed, 52 insertions(+), 3 deletions(-) diff --git a/docs/docs-content/legal-licenses/oss-licenses-index/pxk-oss-licenses.md b/docs/docs-content/legal-licenses/oss-licenses-index/pxk-oss-licenses.md index b341370999..0e5f1b8361 100644 --- a/docs/docs-content/legal-licenses/oss-licenses-index/pxk-oss-licenses.md +++ b/docs/docs-content/legal-licenses/oss-licenses-index/pxk-oss-licenses.md @@ -1,8 +1,8 @@ --- sidebar_label: "Palette eXtended Kubernetes" -title: "PXK Open-source Licenses" +title: "PXK Open Source Licenses" description: - "Review the open-source licenses tied to the libraries and modules currently in use by Palette eXtended Kubernetes + "Review the open source licenses tied to the libraries and modules currently in use by Palette eXtended Kubernetes (PXK)." sidebar_position: 20 tags: ["legal", "licenses", "pxk"] @@ -10,7 +10,56 @@ tags: ["legal", "licenses", "pxk"] -The following table lists the open-source licenses associated with the libraries and modules currently in use by and the Federal Information Processing Standards (FIPS) compliant version of PXK. +The following table lists the open source licenses associated with the libraries and modules currently in use by and the Federal Information Processing Standards (FIPS) compliant version of PXK. + +## PXK License + +PXK is released under the [Apache-2.0 license](https://www.apache.org/licenses/LICENSE-2.0). + +## PXK Components + +All PXK components and supporting open source components are compiled in their native programming language. Below is a +list of the core and auxiliary Kubernetes components that are included in PXK. + +
+ +### Core Kubernetes Components + +| **Component** | **Description** | +| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | +| API Server | The API server is the central management entity that receives all REST requests for the cluster. | +| Controller Manager | The controller manager is a daemon that embeds the core control loops shipped with Kubernetes. | +| Scheduler | The scheduler is a daemon that finds the best node for a pod, based on the scheduling requirements you specify. | +| Kubelet | The kubelet is the primary _node agent_ that is deployed on each node. | +| Kube-proxy | The kube-proxy is a network proxy that operates on each node in your cluster, implementing part of the Kubernetes Service concept. | +| Kubeadm | Kubeadm is a tool built to provide best-practice “fast paths” for creating Kubernetes clusters. | +| Kubectl | Kubectl is a command line interface for issuing commands against Kubernetes clusters. | + +### Auxiliary Kubernetes Components + +| **Component** | **Description** | +| ------------- | --------------------------------------------------------------------------------------------- | +| CoreDNS | CoreDNS is a Domain Name System (DNS) server deployed as a cluster DNS service. | +| Etcd | Etcd is a distributed key-value store used as Kubernetes’ backing store for all cluster data. | + +### Runtime Components + +| **Component** | **Description** | +| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | +| containerd | Containerd is an industry-standard container runtime with an emphasis on simplicity, robustness, and portability. | +| containerd-shim | Containerd-shim is a shim used by containerd to launch containers. | +| containerd-shim-runc-v1 | Containerd-shim-runc-v1 is a shim used by containerd to launch containers. | +| containerd-shim-runc-v2 | Containerd-shim-runc-v2 is a shim used by containerd to launch containers. | +| ctr | Ctr is a command line interface for containerd. | +| crictl | Crictl is a command line interface for CRI-compatible container runtimes. | +| runc | Runc is a CLI tool for spawning and managing containers according to the OCI specification. | + +
+ +## Open Source Dependencies + +The following table lists the open source libraries and modules currently in use by PXK and the Federal Information +Processing Standards (FIPS) compliant version of PXK. | Library | License | | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |