Skip to content

Pulling standard APIs up and hiding experimental apis behind a feature flag #137

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
merged 3 commits into from
May 8, 2025
Merged

Pulling standard APIs up and hiding experimental apis behind a feature flag #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
57f6478
Pulling standard APIs up and hiding experimental apis behind a featur…
dawid-nowak Apr 27, 2025
b553b48
Core review changes
dawid-nowak May 6, 2025
689c03a
Code review two.. bringing back the apis
dawid-nowak May 8, 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
8 changes: 6 additions & 2 deletions gateway-api/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ serde.workspace = true
serde_yaml.workspace = true

[dev-dependencies]
k8s-openapi = { workspace = true, features = [ "v1_32", "schemars" ] }
k8s-openapi = { workspace = true, features = ["v1_32", "schemars"] }
kube = { workspace = true, features = ["derive"] }

anyhow.workspace = true
Expand All @@ -35,4 +35,8 @@ tower.workspace = true
uuid.workspace = true

[package.metadata.docs.rs]
features = [ "k8s-openapi/v1_32" ]
features = ["k8s-openapi/v1_32"]

[features]
default = []
experimental = []
9 changes: 6 additions & 3 deletions gateway-api/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
pub mod apis;

pub mod duration;
pub use duration::Duration;
pub mod apis;
pub use apis::standard::*;

#[cfg(feature = "experimental")]
pub use apis::experimental;

#[cfg(test)]
mod tests {
Expand All @@ -22,7 +25,7 @@ mod tests {
use tower::ServiceBuilder;
use uuid::Uuid;

use crate::apis::standard::{
use crate::{
constants::{
GatewayConditionReason, GatewayConditionType, ListenerConditionReason,
ListenerConditionType,
Expand Down
41 changes: 22 additions & 19 deletions update.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,26 @@ EXPERIMENTAL_APIS=(
udproutes
)

rm -rf gateway-api/src/apis/
export APIS_DIR='gateway-api/src/apis'
rm -rf $APIS_DIR/standard/
rm -rf $APIS_DIR/experimental/

mkdir -p gateway-api/src/apis/
cat << EOF > gateway-api/src/apis/mod.rs
cat << EOF > $APIS_DIR/mod.rs
pub mod experimental;
pub mod standard;
EOF

mkdir -p gateway-api/src/apis/standard/
mkdir -p gateway-api/src/apis/experimental/

echo "// WARNING! generated file do not edit" > gateway-api/src/apis/standard/mod.rs
mkdir -p $APIS_DIR/standard/
mkdir -p $APIS_DIR/experimental/

echo "// WARNING! generated file do not edit" > $APIS_DIR/standard/mod.rs

for API in "${STANDARD_APIS[@]}"
do
echo "generating standard api ${API}"
curl -sSL "https://raw.githubusercontent.com/kubernetes-sigs/gateway-api/${VERSION}/config/crd/standard/gateway.networking.k8s.io_${API}.yaml" | kopium --schema=derived --derive=JsonSchema --derive=Default --derive=PartialEq --docs -f - > gateway-api/src/apis/standard/${API}.rs
echo "pub mod ${API};" >> gateway-api/src/apis/standard/mod.rs
curl -sSL "https://raw.githubusercontent.com/kubernetes-sigs/gateway-api/${VERSION}/config/crd/standard/gateway.networking.k8s.io_${API}.yaml" | kopium --schema=derived --derive=JsonSchema --derive=Default --derive=PartialEq --docs -f - > $APIS_DIR/standard/${API}.rs
echo "pub mod ${API};" >> $APIS_DIR/standard/mod.rs
done

# Standard API enums that need a Default trait impl along with their respective default variant.
Expand All @@ -71,8 +73,8 @@ ENUMS_WITH_DEFAULTS=$(printf ",%s" "${ENUMS[@]}")
ENUMS_WITH_DEFAULTS=${ENUMS_WITH_DEFAULTS:1}

# The task searches for $GATEWAY_API_ENUMS in the enviornment to get the enum names and their default variants.
GATEWAY_API_ENUMS=${ENUMS_WITH_DEFAULTS} cargo xtask gen_enum_defaults >> gateway-api/src/apis/standard/enum_defaults.rs
echo "mod enum_defaults;" >> gateway-api/src/apis/standard/mod.rs
GATEWAY_API_ENUMS=${ENUMS_WITH_DEFAULTS} cargo xtask gen_enum_defaults >> $APIS_DIR/standard/enum_defaults.rs
echo "mod enum_defaults;" >> $APIS_DIR/standard/mod.rs

GATEWAY_CLASS_CONDITION_CONSTANTS="GatewayClassConditionType=Accepted"
GATEWAY_CLASS_REASON_CONSTANTS="GatewayClassConditionReason=Accepted,InvalidParameters,Pending,Unsupported,Waiting"
Expand All @@ -84,16 +86,16 @@ LISTENER_REASON_CONSTANTS="ListenerConditionReason=HostnameConflict,ProtocolConf
GATEWAY_CLASS_CONDITION_CONSTANTS=${GATEWAY_CLASS_CONDITION_CONSTANTS} GATEWAY_CLASS_REASON_CONSTANTS=${GATEWAY_CLASS_REASON_CONSTANTS} \
GATEWAY_CONDITION_CONSTANTS=${GATEWAY_CONDITION_CONSTANTS} GATEWAY_REASON_CONSTANTS=${GATEWAY_REASON_CONSTANTS} \
LISTENER_CONDITION_CONSTANTS=${LISTENER_CONDITION_CONSTANTS} LISTENER_REASON_CONSTANTS=${LISTENER_REASON_CONSTANTS} \
cargo xtask gen_condition_constants >> gateway-api/src/apis/standard/constants.rs
echo "pub mod constants;" >> gateway-api/src/apis/standard/mod.rs
cargo xtask gen_condition_constants >> $APIS_DIR/standard/constants.rs
echo "pub mod constants;" >> $APIS_DIR/standard/mod.rs

echo "// WARNING! generated file do not edit" > gateway-api/src/apis/experimental/mod.rs
echo "// WARNING! generated file do not edit" > $APIS_DIR/experimental/mod.rs

for API in "${EXPERIMENTAL_APIS[@]}"
do
echo "generating experimental api $API"
curl -sSL "https://raw.githubusercontent.com/kubernetes-sigs/gateway-api/${VERSION}/config/crd/experimental/gateway.networking.k8s.io_${API}.yaml" | kopium --schema=derived --derive=JsonSchema --derive=Default --derive=PartialEq --docs -f - > gateway-api/src/apis/experimental/${API}.rs
echo "pub mod ${API};" >> gateway-api/src/apis/experimental/mod.rs
curl -sSL "https://raw.githubusercontent.com/kubernetes-sigs/gateway-api/${VERSION}/config/crd/experimental/gateway.networking.k8s.io_${API}.yaml" | kopium --schema=derived --derive=JsonSchema --derive=Default --derive=PartialEq --docs -f - > $APIS_DIR/experimental/${API}.rs
echo "pub mod ${API};" >> $APIS_DIR/experimental/mod.rs
done

# Experimental API enums that need a Default trait impl along with their respective default variant.
Expand All @@ -110,8 +112,8 @@ ENUMS=(

ENUMS_WITH_DEFAULTS=$(printf ",%s" "${ENUMS[@]}")
ENUMS_WITH_DEFAULTS=${ENUMS_WITH_DEFAULTS:1}
GATEWAY_API_ENUMS=${ENUMS_WITH_DEFAULTS} cargo xtask gen_enum_defaults >> gateway-api/src/apis/experimental/enum_defaults.rs
echo "mod enum_defaults;" >> gateway-api/src/apis/experimental/mod.rs
GATEWAY_API_ENUMS=${ENUMS_WITH_DEFAULTS} cargo xtask gen_enum_defaults >> $APIS_DIR/experimental/enum_defaults.rs
echo "mod enum_defaults;" >> $APIS_DIR/experimental/mod.rs

# GatewayClass conditions vary between standard and experimental
GATEWAY_CLASS_CONDITION_CONSTANTS="${GATEWAY_CLASS_CONDITION_CONSTANTS},SupportedVersion"
Expand All @@ -120,8 +122,9 @@ GATEWAY_CLASS_REASON_CONSTANTS="${GATEWAY_CLASS_REASON_CONSTANTS},SupportedVersi
GATEWAY_CLASS_CONDITION_CONSTANTS=${GATEWAY_CLASS_CONDITION_CONSTANTS} GATEWAY_CLASS_REASON_CONSTANTS=${GATEWAY_CLASS_REASON_CONSTANTS} \
GATEWAY_CONDITION_CONSTANTS=${GATEWAY_CONDITION_CONSTANTS} GATEWAY_REASON_CONSTANTS=${GATEWAY_REASON_CONSTANTS} \
LISTENER_CONDITION_CONSTANTS=${LISTENER_CONDITION_CONSTANTS} LISTENER_REASON_CONSTANTS=${LISTENER_REASON_CONSTANTS} \
cargo xtask gen_condition_constants >> gateway-api/src/apis/experimental/constants.rs
echo "pub mod constants;" >> gateway-api/src/apis/experimental/mod.rs
cargo xtask gen_condition_constants >> $APIS_DIR/experimental/constants.rs
echo "pub mod constants;" >> $APIS_DIR/experimental/mod.rs

# Format the code.
cargo fmt

Loading