Fix the doc/schema descriptions to the new NetworkID limit (11->10)

nokia · May 8, 2020 · ea8f0a9 · ea8f0a9
1 parent 927e184
commit ea8f0a9
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/schema/ClusterNetwork.yaml b/schema/ClusterNetwork.yaml
@@ -16,7 +16,7 @@ spec:
   # For static delegates, the parameter configures which CNI configuration file is to be used if NetworkType points to a static-level CNI backend.
   # VxLAN host interfaces are suffixed, while VLAN host interfaces are prefixed with the NetworkID.
   # This allows deployment administrators to separate their own interfaces from others' in a multi-tenant environment, i.e. by setting NetworkID to "name_namespace" value.
-  # OPTIONAL - STRING, MAXIMUM 11 CHARACTERS
+  # OPTIONAL - STRING, MAXIMUM 10 CHARACTERS
   NetworkID: ## NETWORK_ID  ##
   # This parameter, denotes which backend is used to provision the container interface connected to this network.
   # Currently supported values with dynamic integration level are IPVLAN (default), SRIOV, or MACVLAN.

diff --git a/schema/DanmNet.yaml b/schema/DanmNet.yaml
@@ -15,7 +15,7 @@ spec:
   # For static delegates, the parameter configures which CNI configuration file is to be used if NetworkType points to a static-level CNI backend.
   # VxLAN host interfaces are suffixed, while VLAN host interfaces are prefixed with the NetworkID.
   # This allows deployment administrators to separate their own interfaces from others' in a multi-tenant environment, i.e. by setting NetworkID to "name_namespace" value.
-  # OPTIONAL - STRING, MAXIMUM 11 CHARACTERS
+  # OPTIONAL - STRING, MAXIMUM 10 CHARACTERS
   NetworkID: ## NETWORK_ID  ##
   # This parameter, denotes which backend is used to provision the container interface connected to this network.
   # Currently supported values with dynamic integration level are IPVLAN (default), SRIOV, or MACVLAN.

diff --git a/schema/TenantNetwork.yaml b/schema/TenantNetwork.yaml
@@ -20,7 +20,7 @@ spec:
   # For static delegates, the parameter configures which CNI configuration file is to be used if NetworkType points to a static-level CNI backend.
   # VxLAN host interfaces are suffixed, while VLAN host interfaces are prefixed with the NetworkID.
   # This allows deployment administrators to separate their own interfaces from others' in a multi-tenant environment, i.e. by setting NetworkID to "name_namespace" value.
-  # OPTIONAL - STRING, MAXIMUM 11 CHARACTERS
+  # OPTIONAL - STRING, MAXIMUM 10 CHARACTERS
   # IN CASE THE CLUSTER ADMINISTRATOR DEFINED A NETWORKID IN THE USER'S TENANT FOR A SPECIFIC BACKEND, IT WILL OVERWRITE THE USER PROVIDED VALUE.
   NetworkID: ## NETWORK_ID  ##
   # This parameter, denotes which backend is used to provision the container interface connected to this network.

diff --git a/user-guide.md b/user-guide.md
@@ -417,7 +417,7 @@ Every CREATE, and ~~PUT~~ (see [https://github.com/nokia/danm/issues/144](https:
  15. spec.Options.Allocation_pool_V6.Cidr must be supplied in a valid IPv6 CIDR notation, and must be in the provided IPv6 CIDR
  16. The combined number of allocatable IP addresses of the manually provided IPv4 and IPv6 allocation CIDRs cannot be higher than 8 million
  17. spec.Options.Vlan and spec.Options.Vxlan cannot be provided together
- 18. spec.NetworkID cannot be longer than 11 characters for dynamic backends
+ 18. spec.NetworkID cannot be longer than 10 characters for dynamic backends
  19. spec.AllowedTenants is not a valid parameter for this API type
  20. spec.Options.Device_pool must be, and spec.Options.Host_device mustn't be provided for K8s Devices based networks (such as SR-IOV)
  21. Any of spec.Options.Device, spec.Options.Vlan, or spec.Options.Vxlan attributes cannot be changed if there are any Pods currently connected to the network
@@ -452,7 +452,7 @@ Every CREATE, and PUT TenantConfig operation is subject to the following validat
  1. Either HostDevices, or NetworkIDs must not be empty
  2. VniType and VniRange must be defined together for every HostDevices entry
  3. Both key, and value must not be empty in every NetworkType: NetworkID mapping entry
- 4. A NetworkID cannot be longer than 11 characters in a NetworkType: NetworkID mapping belonging to a dynamic NetworkType
+ 4. A NetworkID cannot be longer than 10 characters in a NetworkType: NetworkID mapping belonging to a dynamic NetworkType
 
 ### Usage of DANM's Netwatcher component
 Netwatcher is a mandatory component of the DANM networking suite.