Skip to content
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

Jump to bottom

docs: formatting updates to api reference #276

Closed
wants to merge 38 commits into from
Closed

docs: formatting updates to api reference #276

wants to merge 38 commits into from

Conversation

ericmariasis
Copy link
Contributor

Commit Message

This commit makes the resource names larger and more readable as well as some other header fields.
In addition, there is now a "back to top" button at the bottom of the page.

Related Issues/PRs (if applicable)

Fixes issue #241.

@ericmariasis ericmariasis requested a review from a team as a code owner February 2, 2025 21:49
@mathetake
Copy link
Member

@ericmariasis Hey, please do not repeat many times again. The CI clearly says you are NOT making sure make precommit on your local machine as instructed in CONTRIBUTING.md as well as pull request templates. Please do follow the instruction to avoid wasting my time and anyone following this repository.

@mathetake mathetake marked this pull request as draft February 2, 2025 21:54
@ericmariasis
Copy link
Contributor Author

Some past comments are in PR 271.

@mathetake mathetake removed the request for review from a team February 2, 2025 21:56
@mathetake
Copy link
Member

You shouldn't have recreated another PR that has been doing exactly the same thing. There's absolutely no reason to do that under any circumstances. Even if that is ok, how do you think (new) in the title will be helpful as a commit message if you see in the commit message in the future. No making sense.

@ericmariasis ericmariasis marked this pull request as ready for review February 2, 2025 23:31
@missBerg missBerg changed the title docs: formatting updates to api reference (new) docs: formatting updates to api reference Feb 4, 2025
@missBerg missBerg added the documentation Improvements or additions to documentation label Feb 4, 2025
@missBerg
Copy link
Contributor

missBerg commented Feb 4, 2025

Looking at the output the changes generate, think we may need to think about how we can organize these better.
I'll slack you @ericmariasis and see what we can come up with!

@missBerg missBerg marked this pull request as draft February 4, 2025 16:50
mathetake and others added 19 commits February 7, 2025 10:02
@mathetake @ericmariasis
test: removes apischema coverage exception (envoyproxy#255)
ef36bb0 
**Commit Message**:

This removes the test coverage exception
of apischema package by adding more
unit tests.

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
ci: upgrades Envoy Gateway to v1.3.0 (envoyproxy#259)
5cb2bb5 
**Commit Message**:

This upgrades the Envoy Gateway version used
in the end to end tests. Also, this changes the
Envoy container tag to use "-latest" without
specifying the patch version.

---------

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@ericmariasis
updates for better headers and a back to top button
bc44655 
Signed-off-by: ericmariasis <ericmariasis829@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@ericmariasis
fixing whitespace in config.yaml
91336ea 
Signed-off-by: ericmariasis <ericmariasis829@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@ericmariasis
ran precommit
4ed8aff 
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@ericmariasis
updating for more user friendly bulleted list approach
357f28a 
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@ericmariasis
docs: removal of deprecated kubectl command in installation.md (envoy…
5439428 
…proxy#264)

**Commit Message**:

Removal of deprecated kubectl command below from [the installation
getting started
guide](https://github.com/envoyproxy/ai-gateway/blob/main/site/docs/getting-started/installation.md).

`kubectl wait --timeout=2m -n envoy-ai-gateway-system
deployment/ai-gateway-controller --for=create
`
It seems to include a deprecated arg ```--for=create```

**Related Issues/PRs (if applicable)**: Fixes [Issue
262](envoyproxy#262)

**Special notes for reviewers (if applicable)**:

Signed-off-by: ericmariasis <ericmariasis829@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
chore: fixes PR style check (envoyproxy#266)
23cab14 
**Commit Message**

This makes the PR style check stricter than before:
* The description's first line must be `**Commit Message**`
* The PR title length must be less than 53 characters

---------

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
ci: cleanup PR Style Check GHA (envoyproxy#268)
3ed81cd 
**Commit Message**

This refactors the PR style check github workflow.
* Renamed the file to match the workflow name.
* Split the description checks into multiple runs.

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
ci: relaxes PR title length check (envoyproxy#269)
41e4271 
**Commit Message**

This follows up on envoyproxy#266 and relaxes the PR title length
restriction to 60 characters. It was too strict.

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@ericmariasis @mathetake
docs: add note for Windows users in basic usage (envoyproxy#265)
bcd2d13 
**Commit Message**
Added note for Windows users in basic usage that they can use WSL for
commands not working on cmd prompt.

**Related Issues/PRs (if applicable)**

Fixes envoyproxy#263

---------

Signed-off-by: ericmariasis <ericmariasis829@gmail.com>
Co-authored-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
chore: more clarify what to do on Style check failure (envoyproxy#272)
2bbf52d 
**Commit Message**

Apparently, the message was clear enough

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@ericmariasis
Fix description render issue
89de59a 
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@leseb @ericmariasis
ci: skip style checks for dependabot PRs (envoyproxy#282)
e98802b 
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@dependabot @ericmariasis
build(deps): bump github.com/envoyproxy/go-control-plane/envoy from 1…
008a7e3 
….32.3 to 1.32.4 (envoyproxy#281)

Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@dependabot @ericmariasis
build(deps): bump github.com/openai/openai-go from 0.1.0-alpha.50 to …
707d761 
…0.1.0-alpha.51 (envoyproxy#280)

Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@dependabot @ericmariasis
build(deps): bump github.com/aws/aws-sdk-go-v2 from 1.35.0 to 1.36.0 (e…
69085d2 
…nvoyproxy#277)

Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@dependabot @ericmariasis
build(deps): bump github.com/google/cel-go from 0.23.1 to 0.23.2 (env…
757f275 
…oyproxy#279)

Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@leseb @ericmariasis
test: resolve warnings in envoy.yaml (envoyproxy#283)
6d1fc67 
**Commit Message**

Addressed warnings observed during `make test-extproc`, except for the
`reuse_port` warning, which is platform-dependent and cannot be fixed on
non-Linux systems.

- Updated `json_format` to be nested under `log_format` to align with
Envoy's expected configuration.
- Added `overload_manager` configuration to manage downstream connection
limits.
- The warning related to `reuse_port` being force disabled on non-Linux
platforms was **not** fixed, as it is platform-dependent.

Signed-off-by: Sébastien Han <seb@redhat.com>

**Related Issues/PRs (if applicable)**

envoyproxy#274

**Special notes for reviewers (if applicable)**

The warning related to `reuse_port` being force disabled on non-Linux
platforms was **not** fixed, as it is platform-dependent. Any
suggestions for a fix are welcome.

Signed-off-by: Sébastien Han <seb@redhat.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
dependabot bot and others added 17 commits February 7, 2025 10:02
@dependabot @ericmariasis
build(deps): bump github.com/aws/aws-sdk-go-v2/config from 1.29.3 to …
6f0470f 
…1.29.4 (envoyproxy#278)

Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@soma00333 @ericmariasis
ci: add issue title check (envoyproxy#273)
ef2e428 
**Commit Message**

This introduces a new GitHub Actions workflow to check the length of
issue titles and provide feedback if they exceed a specified limit.

**Related Issues/PRs (if applicable)**

Fixes envoyproxy#270

---------

Signed-off-by: soma00333 <soma03432303@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
ci: adjust issue/pr style checks (envoyproxy#284)
78ec796 
**Commit Message**

This adjusts the issue title check as well as the PR style check. For
issue title, I adopt the suggestion by @leseb as indeed 60 was too
strict. For the PR stuff, it simply changes it to forbid >60.

---------

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
ci: stricter permissions on style/tests workflows (envoyproxy#288)
d4df342 
**Commit Message**

This puts stricter permissions on Tests and Style
GitHub Actions workflows.

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@daixiang0 @mathetake @ericmariasis
controller: mark all volume mounts ReadOnly=true (envoyproxy#252)
63865c7 
**Commit Message**

Mark all volume mounts readonly to ensure security.

**Related Issues/PRs (if applicable)**

Fix envoyproxy#250

---------

Signed-off-by: Loong <long0dai@foxmail.com>
Co-authored-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
examples: adds token rate limit (envoyproxy#289)
219ffce 
**Commit Message**

This add a CEL expression token usage example that is
missing from the example as well as the e2e test.

**Related Issues/PRs (if applicable)**

closes envoyproxy#257

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
test: clean up real provider extproc test (envoyproxy#291)
ff82f6f 
**Commit Message**

This cleans up some logic for old Envoy versions in
log parsing. Also, this adds additional test log
for debugging a flaky streaming test with openai.

**Related Issues/PRs (if applicable)**

Related to envoyproxy#290

---------

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
examples: simplifies token_ratelimit.yaml (envoyproxy#292)
3aefe8c 
**Commit Message**

The weight field does not need to be specified if there's only
one backend since envoyproxy#156. This removes it in token_ratelimit.yaml.

**Related Issues/PRs (if applicable)**

Follow up on envoyproxy#289

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
controller: eliminates context.Background (envoyproxy#295)
32c49d1 
**Commit Message**

This refactors the controller package to eliminate
all the context.Background usages in the main code
path.

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
extproc: eliminates context.Background (envoyproxy#296)
e44314b 
**Commit Message**

This refactors the extproc package and
eliminates all context.Background usages.

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
extproc: eliminates context.Background in config loader (envoyproxy#297)
44470e6 
**Commit Message**

This eliminates context.Background in config loading
code path.

**Related Issues/PRs (if applicable)**

This is a follow up on envoyproxy#296

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
chore: stricter golangci-lint (envoyproxy#298)
061a659 
**Commit Message**

This makes the lint settings stricter and
starts enforcing more rules.

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
docs: more comment about generated resources in API (envoyproxy#294)
9c7279a 
**Commit Message**

This adds additional doc comments on AIGatewayRoute resource
about which k8s resources will be created by Envoy AI Gateway.

**Related Issues/PRs (if applicable)**

Closes envoyproxy#258

---------

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
docs: adds architecture overview (envoyproxy#293)
03885ea 
**Commit Message**

This adds a site page for the architecture overview of the
project.

**Related Issues/PRs (if applicable)**

Closes envoyproxy#240

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@yuzisun @ericmariasis
e2e: support AWS Session Token in real provider test (envoyproxy#299)
3a12cf4 
**Commit Message**
Allow setting AWS session token in the AWS credential file when using
AWS temporary credentials to test AWS Bedrock.

**Related Issues/PRs (if applicable)**

**Special notes for reviewers (if applicable)**
TEST_AWS_SESSION_TOKEN is optional if using static AWS credential.

Signed-off-by: Dan Sun <dsun20@bloomberg.net>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
chore: fixes CEL validation test target name (envoyproxy#300)
214934a 
**Commit Message**

This renames `make test-cel` to `make test-crdcel` to be precise
about what it is testing since we are also using CEL for LLM costs.

Also, this renames the tests/cel-validation directory to tests/crdcel
since it was previously incorrect and didn't match the make target.

---------

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@mathetake @ericmariasis
chore: updates tools (envoyproxy#301)
d328bc8 
**Commit Message**

This updates several tool dependencies.

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Eric Mariasis <ericmariasis829@gmail.com>
@ericmariasis ericmariasis marked this pull request as ready for review February 7, 2025 15:06
@missBerg missBerg mentioned this pull request Feb 9, 2025
Merged
@missBerg
Copy link
Contributor

missBerg commented Feb 9, 2025

@ericmariasis I had a creative Saturday so continued on this and created: #308
:)

@missBerg missBerg closed this Feb 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@ericmariasis @mathetake @missBerg @leseb @soma00333 @daixiang0 @yuzisun