add design documentation

hawkv6 · Aug 13, 2024 · fc49f84 · fc49f84
1 parent 801da83
commit fc49f84
Show file tree

Hide file tree

Showing 15 changed files with 199 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -32,9 +32,6 @@ HawkEye includes a gRPC API that enables clients within the SRv6 network to send
 - **Interoperability**: HawkEye leverages standardized technologies like YANG-Push for telemetry and BMP for performance measurement, ensuring compatibility with existing network hardware and software.
 
 
-## Design Considerations
-
-
 ## Usage
 ```
 hawkeye [command]
@@ -63,9 +60,6 @@ cd hawkeye && make binary
 sudo ./bin/hawkeye
 ```
 
-
-## Intents
-
 ## Getting Started
 
 1. Deploy all necessary Kubernetes resources.
@@ -86,6 +80,7 @@ sudo ./bin/hawkeye
    - For more information, refer to the [start command documentation](docs/commands/start.md).
 
 ## Additional Information
+- The design considerations are documented in the [design file](docs/design.md).
 - Environment variables are documented in the [env file](docs/env.md).
 - The proto definiton is included via submodule and can be found [here](https://github.com/hawkv6/proto/blob/main/intent.proto).
 - Limitations are documented in the [limitations file](docs/limitations.md).
diff --git a/docs/design.md b/docs/design.md
diff --git a/docs/env.md b/docs/env.md
@@ -19,3 +19,7 @@ HawkEye can be configured using the following environment variables:
 - **`HAWKEYE_THREE_FACTOR_WEIGHTS`**: Sets the weights for requests involving three factors. Accepts a comma-separated string of float values. Default is `0.7,0.2,0.1`.
 
 - **`HAWKEYE_SKIP_TLS_VERIFICATION`**: Skips TLS verification when set to `true` or `TRUE`. The default is `false`.
+
+- **`HAWKEYE_CONSUL_QUERY_WAIT_TIME`**: Sets the wait time for Consul long-polling queries. The default is `5s`.
+
+- **`HAWKEYE_NETWORK_PROCESSOR_HOLD_TIME`**: Sets the hold time for the network processor. The default is `1s`. Meaning the network processor will trigger a recalculation if no updates are received within x seconds.
diff --git a/docs/images/Hawkv6-HawkEye-Cache-Functionality.drawio.svg b/docs/images/Hawkv6-HawkEye-Cache-Functionality.drawio.svg
diff --git a/docs/images/Hawkv6-HawkEye-Consul-Healthy-Nodes.png b/docs/images/Hawkv6-HawkEye-Consul-Healthy-Nodes.png
diff --git a/docs/images/Hawkv6-HawkEye-Design-Considerations.drawio.svg b/docs/images/Hawkv6-HawkEye-Design-Considerations.drawio.svg
diff --git a/docs/images/Hawkv6-HawkEye-Graph-Overview.drawio.svg b/docs/images/Hawkv6-HawkEye-Graph-Overview.drawio.svg
diff --git a/docs/images/Hawkv6-HawkEye-Maximum-Constraint.drawio.svg b/docs/images/Hawkv6-HawkEye-Maximum-Constraint.drawio.svg
diff --git a/docs/images/Hawkv6-HawkEye-Minimum-Constraint.drawio.svg b/docs/images/Hawkv6-HawkEye-Minimum-Constraint.drawio.svg
diff --git a/docs/images/Hawkv6-HawkEye-SERA1-Failing-Health-Check.png b/docs/images/Hawkv6-HawkEye-SERA1-Failing-Health-Check.png
diff --git a/docs/images/Hawkv6-HawkEye-SERA1-Health-Check-Overview.png b/docs/images/Hawkv6-HawkEye-SERA1-Health-Check-Overview.png
diff --git a/docs/images/Hawkv6-HawkEye-SFC-Overview.drawio.svg b/docs/images/Hawkv6-HawkEye-SFC-Overview.drawio.svg
diff --git a/docs/images/Hawkv6-HawkEye-ShortestPath-Overview.drawio.svg b/docs/images/Hawkv6-HawkEye-ShortestPath-Overview.drawio.svg
diff --git a/docs/intents/overview.md b/docs/intents/overview.md
diff --git a/pkg/helper/env.go b/pkg/helper/env.go
@@ -53,15 +53,6 @@ var ConsulQueryWaitTime time.Duration = func() time.Duration {
 	return 5 * time.Second
 }()
 
-var RollingWindowSize uint8 = func() uint8 {
-	if value, exists := os.LookupEnv("HAWKEYE_ROLLING_WINDOWS_SIZE"); exists {
-		if temp, err := strconv.ParseUint(value, 10, 8); err == nil {
-			return uint8(temp)
-		}
-	}
-	return 5
-}()
-
 var NetworkProcessorHoldTime time.Duration = func() time.Duration {
 	if value, exists := os.LookupEnv("HAWKEYE_NETWORK_PROCESSOR_HOLD_TIME"); exists {
 		if temp, err := strconv.ParseInt(value, 10, 64); err == nil {