Skip to content

Commit 508424e

Browse files
janetkuok8s-ci-robot
authored andcommitted
Add installation guide
1 parent ce266ae commit 508424e

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@
44

55
This project is developing a `Sandbox` Custom Resource Definition (CRD) and controller for Kubernetes, under the umbrella of [SIG Apps](https://github.com/kubernetes/community/tree/master/sig-apps). The goal is to provide a declarative, standardized API for managing workloads that require the characteristics of a long-running, stateful, singleton container with a stable identity, much like a lightweight, single-container VM experience built on Kubernetes primitives.
66

7+
## Installation
8+
9+
You can install the agent-sandbox controller and its CRDs with the following command.
10+
11+
```sh
12+
export VERSION="vX.Y.Z" # Replace with your desired version from https://github.com/kubernetes-sigs/agent-sandbox/releases
13+
14+
# To install only the core components:
15+
kubectl apply -f https://github.com/kubernetes-sigs/agent-sandbox/releases/download/${VERSION}/manifest.yaml
16+
# To install extensions components:
17+
kubectl apply -f https://github.com/kubernetes-sigs/agent-sandbox/releases/download/${VERSION}/extensions.yaml
18+
```
19+
720
## Motivation
821

922
Kubernetes excels at managing stateless, replicated applications (Deployments) and stable, numbered sets of stateful pods (StatefulSets). However, there's a growing need for an abstraction to handle use cases such as:

0 commit comments

Comments
 (0)