Skip to content

Update documentation #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pranavcracker wants to merge 2 commits into
base: main
Choose a base branch
from
+16 −16
Open

Update documentation #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd12c1a
doc-update
pranavcracker Feb 4, 2026
d8e057b
doc-update
pranavcracker Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions documentation/internal/design/2-extend-service-names-for-multiple-services.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Suppose we have two services `serviceA` and `serviceB`, dependent from `serviceA

In services helms:
```yaml
apiVersion: legacy.qubership.org/v2
apiVersion: netcracker.com/v2
kind: SiteManager
metadata:
name: {{ .Values.namespace }}-serviceA
Expand All @@ -84,7 +84,7 @@ spec:
after: []
before: []
---
apiVersion: legacy.qubership.org/v2
apiVersion: netcracker.com/v2
kind: SiteManager
metadata:
name: {{ .Values.namespace }}-serviceB
Expand All @@ -97,7 +97,7 @@ spec:

In cluster:
```yaml
apiVersion: legacy.qubership.org/v2
apiVersion: netcracker.com/v2
kind: SiteManager
metadata:
name: ns1-serviceA
Expand All @@ -107,7 +107,7 @@ spec:
after: []
before: []
---
apiVersion: legacy.qubership.org/v2
apiVersion: netcracker.com/v2
kind: SiteManager
metadata:
name: ns2-serviceB
Expand All @@ -123,7 +123,7 @@ spec:
In services helms nothing changes;
In cluster:
```yaml
apiVersion: legacy.qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
name: ns1-serviceA
Expand All @@ -133,7 +133,7 @@ spec:
after: []
before: []
---
apiVersion: legacy.qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
name: ns2-serviceB
Expand All @@ -148,7 +148,7 @@ spec:
#### 2. After changing CR names in services helms and redeploy
In services helms:
```yaml
apiVersion: legacy.qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
name: serviceA
Expand All @@ -157,7 +157,7 @@ spec:
after: []
before: []
---
apiVersion: legacy.qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
name: serviceB
Expand All @@ -169,7 +169,7 @@ spec:
```
In cluster:
```yaml
apiVersion: legacy.qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
name: serviceA
Expand All @@ -179,7 +179,7 @@ spec:
after: []
before: []
---
apiVersion: legacy.qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
name: serviceB
Expand Down Expand Up @@ -268,7 +268,7 @@ on different sites:

We can add special optional field to define service name for opponent site, e.g. for `site-1`:
```yaml
apiVersion: legacy.qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
name: sm-dummy
Expand Down Expand Up @@ -297,7 +297,7 @@ In sm-client this field can be used to make links between services with differen

We can add special optional field to override service name, e.g. for `site-1`:
```yaml
apiVersion: legacy.qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
name: sm-dummy
Expand Down Expand Up @@ -335,7 +335,7 @@ spec:

We can add special optional field to turn on/off adding namespace to service name (`isUniqueOnCluster`, default is false):
```yaml
apiVersion: legacy.qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
name: sm-dummy
Expand Down Expand Up @@ -374,7 +374,7 @@ is `<cr-name>` like now:
We can add namespaces only for services with specific volumes (e.g. not stateful). As result, services with
another module will have the same name:
```yaml
apiVersion: legacy.qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
name: sm-dummy
Expand Down
4 changes: 2 additions & 2 deletions documentation/public/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ services of the standby Kubernetes cluster.
CR SiteManager description:

```yaml
apiVersion: qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
name: <SERVICE>
Expand Down Expand Up @@ -170,7 +170,7 @@ for details;
Example for `postgres` service:

```yaml
apiVersion: qubership.org/v3
apiVersion: netcracker.com/v3
kind: SiteManager
metadata:
annotations:
Expand Down
Loading