Troubleshooting#
This section contains information on how to troubleshoot an SDCIO instance that is causing some trouble.
Config-Server#
The Config-Server provides the extension kubernetes apiserver and can therefor be mainly throubleshooted via kubectl.
API Registration#
The Config-Server hooks in to the kubernetes apiserver by registering its APIs. If the apiregistration does not show up as AVAILABLE == True, then further investigation is required.
The two services should be available.
NAME SERVICE AVAILABLE AGE
v1alpha1.config.sdcio.dev network-system/config-server True 6d
v1alpha1.inv.sdcio.dev Local True 6d
Deployment#
The Config-Server is deployed in the network-system namespace via a Deployment. Check for it to be READY. If it is not ready follow the basic troubleshooting for Deployments.
There should be a config-server in the Ready state.Service#
For the APIServer a Service is referenced, this reference must resolve to the config-server. Via the Endpoints the association to the pod can be verified.
The Subsets addresses must list the config-server pod.
apiVersion: v1
kind: Endpoints
metadata:
annotations:
endpoints.kubernetes.io/last-change-trigger-time: "2024-02-09T13:13:34Z"
creationTimestamp: "2024-02-09T13:13:34Z"
labels:
sdcio.dev/config-server: "true"
name: config-server
namespace: network-system
resourceVersion: "439928"
uid: 8f849512-6021-4c7e-a08b-c3cff25ed68b
subsets:
- addresses:
- ip: 10.244.0.8
nodeName: api-server-control-plane
targetRef:
kind: Pod
name: config-server-84465fd854-bm258
namespace: network-system
uid: b6986782-4055-431a-9742-f074d88febb5
ports:
- port: 6443
protocol: TCP
SDCTL#
sdctl is a binary available for gRPC interaction with the schema-server, data-server and cache. In a kubernetes environment, it can be launched by executing a container image.
kubectl run -ti --rm sdctl --image=ghcr.io/sdcio/sdctl:v0.0.6 --restart=Never --command -- /bin/bash
Schema-Server#
kubectl run -ti --rm sdctl --image=ghcr.io/sdcio/sdctl:v0.0.6 --restart=Never --command -- /app/sdctl -a data-server.network-system.svc.cluster.local:56000 schema list
schema list
kubectl run -ti --rm sdctl --image=ghcr.io/sdcio/sdctl:v0.0.6 --restart=Never --command -- /app/sdctl -a data-server.network-system.svc.cluster.local:56000 schema get --vendor sros.nokia.sdcio.dev --version 23.10.2 --path /configure
schema get
sdctl:/app$ /app/sdctl -a data-server.network-system.svc.cluster.local:56000 schema get --vendor sros.nokia.sdcio.dev --version 23.10.2 --path /configure
request:
path: {
elem: {
name: "configure"
}
}
schema: {
vendor: "sros.nokia.sdcio.dev"
version: "23.10.2"
}
response:
schema: {
container: {
name: "configure"
description: "Configure system configuration"
namespace: "urn:nokia.com:sros:ns:yang:sr:conf"
prefix: "conf"
leaflists: {
name: "apply-groups"
description: "Apply a configuration group at this level"
namespace: "urn:nokia.com:sros:ns:yang:sr:conf"
prefix: "conf"
type: {
type: "leafref"
type_name: "leafref"
leafref: "../groups/group/name"
}
max_elements: 8
is_user_ordered: true
}
children: "aaa"
children: "anysec"
children: "application-assurance"
children: "aps"
children: "bfd"
children: "bmp"
children: "call-trace"
children: "card"
children: "cflowd"
children: "chassis"
children: "connection-profile"
children: "esa"
children: "eth-cfm"
children: "eth-ring"
children: "filter"
children: "fwd-path-ext"
children: "group-encryption"
children: "groups"
children: "ipsec"
children: "isa"
children: "lag"
children: "log"
children: "macsec"
children: "mcac"
children: "mirror"
children: "multicast-management"
children: "oam-pm"
children: "openflow"
children: "policy-options"
children: "port"
children: "port-policy"
children: "port-xc"
children: "pw-port"
children: "python"
children: "qos"
children: "redundancy"
children: "router"
children: "routing-options"
children: "saa"
children: "satellite"
children: "service"
children: "sfm"
children: "subscriber-mgmt"
children: "system"
children: "test-oam"
children: "vrrp"
}
}
sdctl:/app$
schema get 2
sdctl:/app$ /app/sdctl -a data-server.network-system.svc.cluster.local:56000 schema get --vendor srl.nokia.sdcio.dev --version 23.10.1 --path /srl_nokia-interfaces
request:
path: {
elem: {
name: "srl_nokia-interfaces"
}
}
schema: {
vendor: "srl.nokia.sdcio.dev"
version: "23.10.1"
}
response:
schema: {
container: {
name: "srl_nokia-interfaces"
description: "Model for managing network interfaces and subinterfaces.\n\nThis model reuses data items defined in the IETF YANG model for\ninterfaces described by RFC 7223"
namespace: "urn:srl_nokia/interfaces"
prefix: "srl_nokia-if"
children: "interface"
}
}
Data-Server#
Listing data-stores
kubectl run -ti --rm sdctl --image=ghcr.io/sdcio/sdctl:v0.0.6 --restart=Never --command -- /app/sdctl -a data-server.network-system.svc.cluster.local:56000 datastore list
datastore list
datastores: {
name: "default.dev1"
datastore: {
name: "default.dev1"
}
schema: {
vendor: "srl.nokia.sdcio.dev"
version: "23.10.1"
}
target: {
type: "gnmi"
address: "172.18.0.4:57400"
}
}
datastores: {
name: "default.sr1"
datastore: {
name: "default.sr1"
}
schema: {
vendor: "sros.nokia.sdcio.dev"
version: "23.10.2"
}
target: {
type: "netconf"
address: "172.22.1.11:830"
status: CONNECTED
}
}
datastores: {
name: "default.dev2"
datastore: {
name: "default.dev2"
}
schema: {
vendor: "srl.nokia.sdcio.dev"
version: "23.10.1"
}
target: {
type: "gnmi"
address: "172.18.0.3:57400"
}
}
datastores: {
name: "default.sr2"
datastore: {
name: "default.sr2"
}
schema: {
vendor: "sros.nokia.sdcio.dev"
version: "23.10.2"
}
target: {
type: "netconf"
address: "172.22.1.12:830"
status: CONNECTED
}
}
pod "sdctl" deleted
Fetching config from the data-store
kubectl run -ti --rm sdctl --image=ghcr.io/sdcio/sdctl:v0.0.6 --restart=Never --command -- /app/sdctl -a data-server.network-system.svc.cluster.local:56000 data get --ds default.sr1 --path /configure/service
data get
request:
name: "default.sr1"
path: {
elem: {
name: "configure"
}
elem: {
name: "service"
}
}
notification: {
timestamp: 1708694690324217499
update: {
path: {
elem: {
name: "configure"
}
elem: {
name: "service"
}
elem: {
name: "vprn"
key: {
key: "service-name"
value: "vprn123"
}
}
elem: {
name: "admin-state"
}
}
value: {
string_val: "enable"
}
}
}
notification: {
timestamp: 1708694690324355878
update: {
path: {
elem: {
name: "configure"
}
elem: {
name: "service"
}
elem: {
name: "vprn"
key: {
key: "service-name"
value: "vprn123"
}
}
elem: {
name: "customer"
}
}
value: {
string_val: "1"
}
}
}
notification: {
timestamp: 1708694690324481720
update: {
path: {
elem: {
name: "configure"
}
elem: {
name: "service"
}
elem: {
name: "vprn"
key: {
key: "service-name"
value: "vprn123"
}
}
elem: {
name: "service-id"
}
}
value: {
uint_val: 101
}
}
}
notification: {
timestamp: 1708694690324648209
update: {
path: {
elem: {
name: "configure"
}
elem: {
name: "service"
}
elem: {
name: "vprn"
key: {
key: "service-name"
value: "vprn123"
}
}
elem: {
name: "service-name"
}
}
value: {
string_val: "vprn123"
}
}
}