sdcio / docs

Documentation for Schema Driven Configuration
Apache License 2.0
18 stars 4 forks source link

`getting started` typos #63

Open frederic-loui opened 3 weeks ago

frederic-loui commented 3 weeks ago

Hi !

Thanks for applying some correction in PR

I'm revisiting getting started page and somehow there is a typo that escaped your claws when you change crd name.

In section Verification after applying sdcio object there is:

kubectl get sdc

That gives the output below if we follow "blindly"step by step the guide:

❯ kubectl get sdc
error: the server doesn't have a resource type "configs/status"

Instead, Verification step should use:

kubectl get inv

That gives the output below:

❯ kubectl get inv
NAME                        READY   REASON   PROVIDER              ADDRESS              PLATFORM      SERIALNUMBER     MACADDRESS
target.inv.sdcio.dev/dev1   True             srl.nokia.sdcio.dev   172.21.0.200:57400   7220 IXR-D3   Sim Serial No.   1A:A8:00:FF:00:00

NAME                                               READY   URL                                            REF        PROVIDER              VERSION
schema.inv.sdcio.dev/srl.nokia.sdcio.dev-23.10.1   True    https://github.com/nokia/srlinux-yang-models   v23.10.1   srl.nokia.sdcio.dev   23.10.1

NAME                                       READY
discoveryrule.inv.sdcio.dev/dev1-address   True

NAME                                                    AGE
targetconnectionprofile.inv.sdcio.dev/gnmi-skipverify   50m

NAME                                            AGE
targetsyncprofile.inv.sdcio.dev/gnmi-onchange   49m

A sentence such as: "The output provides an overview of all the SDCIO originating CRs. (In this case inv)" can help to help a newcomer to link verification to SDCIO install step

Not a critical typo, but for someone not familiar with K8s this might be confusing. Other than that great getting started page !

henderiw commented 5 days ago

thx for the issue. k get sdc should work. During startup there can be a little lag, but it should resolve in my view. I also fixed the status.

k get sdc
NAME READY REASON TARGET SCHEMA test False Failed default/dev1

NAME READY TARGETS intent1 True 0

NAME READY discoveryrule.inv.sdcio.dev/dr-address False discoveryrule.inv.sdcio.dev/dr-dynamic False discoveryrule.inv.sdcio.dev/dr-static False

NAME READY PROVIDER VERSION URL REF schema.inv.sdcio.dev/eos.arista.4.31.2.f False eos.arista.sdcio.dev 4.31.2.F https://github.com/aristanetworks/yang master schema.inv.sdcio.dev/ex.juniper.23.2r1 False ex.juniper.sdcio.dev 23.2R1 https://github.com/Juniper/yang master schema.inv.sdcio.dev/mx.juniper.23.2r1 mx.juniper.sdcio.dev 23.2R1 https://github.com/Juniper/yang master schema.inv.sdcio.dev/nfx.juniper.23.2r1 nfx.juniper.sdcio.dev 23.2R1 https://github.com/Juniper/yang master schema.inv.sdcio.dev/qfx.juniper.23.2r1 qfx.juniper.sdcio.dev 23.2R1 https://github.com/Juniper/yang master schema.inv.sdcio.dev/srl.nokia.sdcio.dev-23.10.1 True srl.nokia.sdcio.dev 23.10.1 https://github.com/nokia/srlinux-yang-models v23.10.1 schema.inv.sdcio.dev/sros.nokia.sdcio.dev-23.10.1 True sros.nokia.sdcio.dev 23.10.2 https://github.com/nokia/7x50_YangModels sros_23.10.r2

NAME AGE targetconnectionprofile.inv.sdcio.dev/gnmi-skipverify 2m22s targetconnectionprofile.inv.sdcio.dev/netconf 2m22s targetconnectionprofile.inv.sdcio.dev/noop 2m22s

NAME AGE targetsyncprofile.inv.sdcio.dev/gnmi-get 2m22s targetsyncprofile.inv.sdcio.dev/gnmi-onchange-and-once 72s targetsyncprofile.inv.sdcio.dev/netconf-getconfig 2m22s (base) sdcio/config-server - (main) >