You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/core-concepts/inter-step-buffer-service.md
+59-35Lines changed: 59 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,13 @@
1
1
# Inter-Step Buffer Service
2
2
3
-
Inter-Step Buffer Service is the service to provide [Inter-Step Buffers](inter-step-buffer.md).
3
+
Inter-Step Buffer Service is the service to provide
4
+
[Inter-Step Buffers](inter-step-buffer.md).
4
5
5
-
An Inter-Step Buffer Service is described by a [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/). It is required to be existing in a namespace before
6
-
Pipeline objects are created. A sample `InterStepBufferService` with JetStream implementation looks like below.
It is required to be existing in a namespace before Pipeline objects are
9
+
created. A sample `InterStepBufferService` with JetStream implementation looks
10
+
like below.
7
11
8
12
```yaml
9
13
apiVersion: numaflow.numaproj.io/v1alpha1
@@ -15,9 +19,11 @@ spec:
15
19
version: latest # Do NOT use "latest" but a specific version in your real deployment
16
20
```
17
21
18
-
`InterStepBufferService` is a namespaced object. It can be used by all the Pipelines in the same namespace. By default,
19
-
Pipeline objects look for an `InterStepBufferService` named `default`, so a common practice is to create an `InterStepBufferService`
20
-
with the name `default`. If you give the `InterStepBufferService` a name other than `default`, then you need to give the
22
+
`InterStepBufferService` is a namespaced object. It can be used by all the
23
+
Pipelines in the same namespace. By default, Pipeline objects look for an
24
+
`InterStepBufferService`named `default`, so a common practice is to create an
25
+
`InterStepBufferService`with the name `default`. If you give the
26
+
`InterStepBufferService`a name other than `default`, then you need to give the
21
27
same name in the Pipeline spec.
22
28
23
29
```yaml
@@ -38,25 +44,29 @@ kubectl get isbsvc
38
44
39
45
## JetStream
40
46
41
-
`JetStream`is one of the supported `Inter-Step Buffer Service` implementations. A keyword `jetstream` under `spec` means
42
-
a JetStream cluster will be created in the namespace.
47
+
`JetStream`is one of the supported `Inter-Step Buffer Service` implementations.
48
+
A keyword `jetstream` under `spec` means a JetStream cluster will be created in
49
+
the namespace.
43
50
44
-
**For Production Setup**, please make sure you configure [replicas](#replicas), [persistence](#persistence),
45
-
[anti-affinity](#anti-affinity), and [PDB](#pdb).
51
+
**For Production Setup**, please make sure you configure [replicas](#replicas),
52
+
[persistence](#persistence), [anti-affinity](#anti-affinity), and [PDB](#pdb).
46
53
47
54
### Version
48
55
49
-
Property `spec.jetstream.version` is required for a JetStream `InterStepBufferService`. Supported versions can be found
50
-
from the ConfigMap [`numaflow-controller-config`](https://github.com/numaproj/numaflow/blob/main/config/base/controller-manager/numaflow-controller-config.yaml) in the control plane namespace.
56
+
Property `spec.jetstream.version` is required for a JetStream
57
+
`InterStepBufferService`. Supported versions can be found from the ConfigMap
0 commit comments