Introduction
The API documentation for ZEDEDA Edge Kubernetes Service and ZEDEDA Edge Kubernetes App Flows is found in the ZEDEDA Kubernetes Service definition. Remember that the format of your API doc URL is:
https://zedcontrol.YOUR_INSTANCE_NAME.zededa.net/api/v1/docs/
You will likely use the endpoints in this order.
- Create and Manage a ZEDEDA Edge Kubernetes Service Cluster with ZKSClusterInstances
- Create and Manage ZEDEDA Edge Kubernetes Secrets with KubernetesSecrets
- Manage an App from the ZEDEDA Edge Kubernetes App Flows Marketplace with HelmChartManagement and PrivateHelmRepositories
- Manage ZEDEDA Edge Kubernetes App Flows Installed Applications with KubernetesDeployments
- Create and Manage ZEDEDA Edge Kubernetes App Flows Cluster Groupings with ClusterGroups
- Create ZEDEDA Edge Kubernetes App Flows GitOps Repositories with KubernetesGitOps
Prerequisites
- You have read the ZEDEDA Edge Kubernetes Service and ZEDEDA Edge Kubernetes App Flows Overview.
- You’re familiar with How to use the ZEDEDA-API.
- You have onboarded one or more edge nodes.
- Your edge nodes are online.
- Your edge nodes are running the EVE-k v16.0.0 or greater (EVE-OS KVM is not supported).
- For installation, we recommend all the edge nodes be of the same hardware type/model with a minimum of 12 core CPUs, 16 GB RAM, and NVMe SSDs for EVE persistent storage for optimal performance.
- For runtime, EVE-k consumes approximately 4 GB of memory and 2 vCPUs if used for clustering.
- It recommended, though not strictly required, to separate the management traffic from the cluster traffic.
- You have either the SysManager or SysAdmin role in your ZEDEDA Cloud enterprise.