Skip to content

docs: audit and correct API documentation #47

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

Merged
chideat merged 2 commits into from
Sep 2, 2025
Merged

docs: audit and correct API documentation #47

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
17fff34
docs: audit and correct API documentation
google-labs-jules[bot] Sep 2, 2025
704f1c7
Merge branch 'docs-optimize' into update-valkey-examples
chideat Sep 2, 2025
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
25 changes: 15 additions & 10 deletions docs/api/core-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Defines the architecture type for Valkey instances:

| Field | Type | Description |
|-------|------|-------------|
| `storageClassName` | string | Storage class name for persistent volumes |
| `annotations` | map[string]string | Annotations for the storage service |
| `storageClassName` | *string | Storage class name for persistent volumes |
| `capacity` | *resource.Quantity | Storage capacity (defaults to 2x memory limit if not set) |
| `accessMode` | corev1.PersistentVolumeAccessMode | Access mode (default: ReadWriteOnce) |
| `retainAfterDeleted` | bool | Whether to retain storage after deletion |
Expand All @@ -33,11 +34,12 @@ Defines the architecture type for Valkey instances:
| Field | Type | Description |
|-------|------|-------------|
| `serviceType` | corev1.ServiceType | Kubernetes service type (ClusterIP, NodePort, LoadBalancer) |
| `ipFamilyPrefer` | IPFamilyPrefer | IP family preference (IPv4, IPv6, or dual-stack) |
| `loadBalancerIP` | string | Static IP for LoadBalancer services |
| `loadBalancerSourceRanges` | []string | Source IP ranges for LoadBalancer |
| `annotations` | map[string]string | Service annotations |
| `nodePortSequence` | string | NodePort sequence assignment |
| `ipFamilyPrefer` | corev1.IPFamily | IP family preference (IPv4, IPv6) |
Copy link

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description mentions only IPv4 and IPv6, but the original documentation mentioned dual-stack support. If dual-stack is supported, the description should include it, or if it's no longer supported, this change is correct.

Suggested change
| `ipFamilyPrefer` | corev1.IPFamily | IP family preference (IPv4, IPv6) |
| `ipFamilyPrefer` | corev1.IPFamily | IP family preference (IPv4, IPv6, DualStack) |

Copilot uses AI. Check for mistakes.
| `ports` | string | NodePort sequence assignment (e.g., "30000:30000,30001:30001") |
| `enableTLS` | bool | Enable TLS for external access |
| `certIssuer` | string | Certificate issuer for TLS |
| `certIssuerType` | string | Certificate issuer type (ClusterIssuer or Issuer) |

## Monitoring Configuration

Expand All @@ -56,12 +58,16 @@ Defines the architecture type for Valkey instances:

| Field | Type | Description |
|-------|------|-------------|
| `id` | string | Valkey cluster node ID |
| `shardId` | string | Cluster shard ID of the node |
| `role` | NodeRole | Node role (master, replica, sentinel) |
| `ip` | string | Node IP address |
| `port` | int32 | Node port |
| `role` | NodeRole | Node role (master, slave, sentinel) |
| `port` | string | Node port |
Comment on lines +63 to +65
Copy link

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The role description mentions 'master' while the original used 'slave' for replicas. Ensure this terminology change is consistent with the actual API enum values. Also, the port field changed from int32 to string - verify this type change is accurate.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The role description mentions 'master' while the original used 'slave' for replicas. Ensure this terminology change is consistent with the actual API enum values. Also, the port field changed from int32 to string - verify this type change is accurate.

Suggested change
| `port` | string | Node port |
| `port` | int32 | Node port |

Copilot uses AI. Check for mistakes.
| `slots` | string | Cluster slots (for cluster mode) |
| `flags` | string | Node flags |
| `masterId` | string | Master node ID (for replicas) |
| `masterRef` | string | Master node ID (for replicas) |
| `statefulSet` | string | StatefulSet name of the pod |
| `podName` | string | Pod name |
| `nodeName` | string | Kubernetes node name where the pod is running |

## Affinity Policies

Expand All @@ -80,7 +86,6 @@ Predefined affinity policies for pod scheduling:

| Field | Type | Description |
|-------|------|-------------|
| `name` | string | Module name |
| `path` | string | Module file path |
| `args` | []string | Module arguments (Valkey 8.0+) |

Expand Down
8 changes: 0 additions & 8 deletions docs/api/v1alpha1-sentinel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,6 @@ Inherits from `core.InstanceAccess` and adds:
- `Ready` - Sentinel is ready and monitoring
- `Failed` - Sentinel failed to deploy or is in error state

## SentinelMonitorNode

| Field | Type | Description |
|-------|------|-------------|
| `ip` | string | Sentinel node IP address |
| `port` | int32 | Sentinel node port |
| `flags` | string | Node flags |

## Example

```yaml
Expand Down
8 changes: 0 additions & 8 deletions docs/api/v1alpha1-user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,6 @@ status:
- `Ready` - User is ready and configured
- `Pending` - User configuration is pending

## Authorization

| Field | Type | Description |
|-------|------|-------------|
| `username` | string | Username for Valkey |
| `passwordSecret` | string | Password secret for Valkey |
| `tlsSecret` | string | TLS secret |

## ACL Rules

ACL rules follow Valkey ACL syntax. Examples:
Expand Down
Loading