-
Notifications
You must be signed in to change notification settings - Fork 4k
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.
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
Use better flags-docs creator #7811
base: master
Are you sure you want to change the base?
Changes from 7 commits
4d947c7
1f8f2ad
0f3afeb
dc77991
fe761bf
9fba59b
e359469
66cf05c
05bd1fb
71aafda
8d8e29e
2a7d53f
f4ee7f6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
#!/bin/bash | ||
|
||
# Copyright 2025 The Kubernetes Authors. | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
set -o errexit | ||
set -o nounset | ||
set -o pipefail | ||
|
||
SCRIPT_ROOT=$(realpath $(dirname "${BASH_SOURCE[0]}"))/.. | ||
TARGET_FILE="${SCRIPT_ROOT}/docs/flags.md" | ||
COMPONENTS=("admission-controller" "recommender" "updater") | ||
|
||
# Function to extract flags from a binary | ||
extract_flags() { | ||
local binary=$1 | ||
local component=$2 | ||
|
||
if [ ! -f "$binary" ]; then | ||
echo "Error: Binary not found for ${component} at ${binary}" | ||
return 1 | ||
fi | ||
|
||
echo "# What are the parameters to VPA ${component}?" | ||
echo "This document is auto-generated from the flag definitions in the VPA ${component} code." | ||
echo "Last updated: $(date -u '+%Y-%m-%d %H:%M:%S UTC')" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. While I appreciate having the option to see right away how up-to-date this document is, I think we shouldn't include a mechanism which creates a diff in every run. So let's remove the timestamp and instead rely on the change history for this file? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Agree, I'll adjust. Once this is merged, I'll open an issue to address it. |
||
echo | ||
echo "| Flag | Default | Description |" | ||
echo "|------|---------|-------------|" | ||
omerap12 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
$binary --help 2>&1 | grep -E '^\s*-' | while read -r line; do | ||
flag=$(echo "$line" | awk '{print $1}' | sed 's/^-*//;s/=.*$//') | ||
default=$(echo "$line" | sed -n 's/.*default \([^)]*\).*/\1/p') | ||
description=$(echo "$line" | sed -E 's/^\s*-[^[:space:]]+ [^[:space:]]+ //;s/ \(default.*\)//') | ||
description=$(echo "$description" | sed -E "s/^--?${flag}[[:space:]]?//") | ||
|
||
echo "| \`--${flag}\` | ${default} | ${description} |" | ||
done | ||
echo | ||
} | ||
|
||
# Build components | ||
pushd "${SCRIPT_ROOT}" >/dev/null | ||
for component in "${COMPONENTS[@]}"; do | ||
echo "Building ${component}..." | ||
pushd "pkg/${component}" >/dev/null | ||
if ! go build -o ${component} ; then | ||
echo "Error: Failed to build ${component}" | ||
popd >/dev/null | ||
continue | ||
fi | ||
popd >/dev/null | ||
done | ||
popd >/dev/null | ||
|
||
# Generate combined flags documentation | ||
echo "Generating flags documentation..." | ||
{ | ||
echo "# Vertical Pod Autoscaler Flags" | ||
echo "This document contains the flags for all VPA components." | ||
echo | ||
|
||
for component in "${COMPONENTS[@]}"; do | ||
binary="${SCRIPT_ROOT}/pkg/${component}/${component}" | ||
if ! extract_flags "$binary" "$component" ; then | ||
echo "Error: Failed to extract flags for ${component}" | ||
fi | ||
done | ||
} > "${TARGET_FILE}" | ||
|
||
echo "VPA flags documentation has been generated in ${TARGET_FILE}" |
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if it makes sense to mention that it's autogenerated from the default branch?
I could see someone reading the docs in master, assuming that a newly added flag will work for them in their release.
This makes me think that we should also consider how we're showing versioned docs when we release new versions of the VPA. But that's a discussion for a different thread.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I can add this to the script. But a follow-up question - how can a user check if some feature is available in their current VPA version?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, that's tough.
At the moment they can (in theory) browse the repo at the release branch for their current version. But that's something they need to figure out themselves.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Understood.