https://github.com/aliyuncontainerservice/alibabacloud-erdma-controller
https://github.com/aliyuncontainerservice/alibabacloud-erdma-controller
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aliyuncontainerservice/alibabacloud-erdma-controller
- Owner: AliyunContainerService
- License: apache-2.0
- Created: 2024-09-27T01:57:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-09T07:29:55.000Z (12 months ago)
- Last Synced: 2025-07-09T23:37:55.621Z (12 months ago)
- Language: Go
- Size: 166 KB
- Stars: 3
- Watchers: 7
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# alibabacloud-erdma-controller
Kubernetes controller for alibabacloud erdma resource
## Description
Dynamic configure erdma devices on kubernetes nodes, and automatically inject erdma-accelerated networks for Kubernetes Pods.
## Getting Started
### Prerequisites
- helm
- Kubernetes Cluster With AlibabaCloud ECS Nodes
- AlibabaCloud Linux 3 with Kernel Version >= 5.10.134-17
### To Deploy on the cluster
#### create & authorize ram role&policy
alibabacloud-erdma-controller need following permissions:
```json
{
"Version": "1",
"Statement": [
{
"Action": [
"ecs:DescribeInstances",
"ecs:DescribeInstanceTypes",
"ecs:DescribeNetworkInterfaces",
"ecs:ModifyNetworkInterfaceAttribute",
"ecs:CreateNetworkInterface",
"ecs:AttachNetworkInterface"
],
"Resource": [
"*"
],
"Effect": "Allow"
}
]
}
```
#### prepare configuration
prepare a values.yaml file with the following content to authorize controller to access erdma API:
##### use rrsa authorization
```yaml
credentials:
type: "oidc_role_arn"
serviceAccount:
annotations:
pod-identity.alibabacloud.com/role-name: {your-ram-role-name}
```
*need config rrsa components on ACK, [refer doc.](https://help.aliyun.com/zh/ack/ack-managed-and-ack-dedicated/user-guide/use-rrsa-to-authorize-pods-to-access-different-cloud-services)*
##### use access_key authorization
```yaml
credentials:
type: "access_key"
accessKeyID: "{access key}"
accessKeySecret: "{access key secret}"
```
#### helm install
```sh
helm install -f values.yaml --namespace kube-system alibaba-erdma-controller deploy/helm/
```
#### check status
##### check pods
```sh
kubectl get pod -n kube-system | grep erdma
```
##### check erdma devices
```sh
kubectl get erdmadevices
```
##### check device plugin
```sh
kubectl get node -o yaml | grep aliyun/erdma
```
### Using ERDMA Accelerated Network
#### Pod Configurations to Enable ERDMA Accelerated Network
* add `aliyun/erdma` resource in pod spec # config erdma devices for pod
* `network.alibabacloud.com/erdma-smcr: "true"` # config smcr for pod, dynamicially replace tcp connection to erdma, need `network.alibabacloud.com/erdma` enabled first.
#### Example
```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
labels:
app: erdma
name: erdma
spec:
replicas: 1
selector:
matchLabels:
app: erdma
template:
metadata:
labels:
app: erdma
annotations:
network.alibabacloud.com/erdma-smcr: "true"
spec:
containers:
- command:
- sleep
- "360000"
image: registry.aliyuncs.com/wangbs/netdia:latest
name: erdma
resources:
limits:
aliyun/erdma: 1
```
### To Uninstall
uninstall helm
```sh
helm -n kube-system uninstall alibaba-erdma-controller
```
## Build
### Build Controller
```sh
docker build --tag registry.aliyuncs.com/erdma/controller:latest --target controller .
```
### Build Agent
```sh
docker build --tag registry.aliyuncs.com/erdma/agent:latest --target agent .
```
### Build SMCR_INIT
```sh
docker build --tag registry.aliyuncs.com/erdma/smcr_init:latest --target smcr_init .
```
## License
Copyright 2024.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
```text
http://www.apache.org/licenses/LICENSE-2.0
```
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.