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.

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

chore(ES-1457): mention readinessProbes config requirement in middleware changelog #7373

Merged
Changes from all commits
Commits
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
27 changes: 25 additions & 2 deletions packages/middleware/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,18 @@

- **[FIXED]** Fix /readyz returning 503 if readinessProbes not passed in middleware.config.ts

Before this fix, sending a GET request to `http://localhost:4000/readyz` would return { "status": "error" } and a HTTP 503 status. This happened only when `readinessProbes` wasn't added to middleware options (the default behavior)
Before this fix, sending a GET request to `http://localhost:4000/readyz` would return { "status": "error" } and a HTTP 503 status. This happened only when `readinessProbes` wasn't added to middleware options (the default behavior). From now on, the `readinessProbes` is not required and can be removed from `./apps/storefront-middleware/src/index.ts`.

```diff
import { createServer, type CreateServerOptions } from "@vue-storefront/middleware";

async function runApp() {
const app = await createServer(config, {
cors: process.env.NODE_ENV === "production" ? undefined : developmentCorsConfig,
- readinessProbes: []
});
}
```

## 5.3.1

Expand Down Expand Up @@ -103,7 +114,19 @@ If you're using that older template, please change the `Express` type to `Server
- async function runMiddleware(app: Express) {
```

- [ADDED] New GET /readyz endpoint for middleware for using with Kubernetes readiness probes. Please see https://docs.alokai.com/middleware/guides/readiness-probes for more information
- [ADDED] New GET /readyz endpoint for middleware for using with Kubernetes readiness probes. Please see our [documentation](https://docs.alokai.com/guides/kubernetes-probe/readiness-probes) for more information. For the endpoint to work correctly, it is required to pass `readinessProbes` configuration (at least an empty array) to `createServer()` in `./apps/storefront-middleware/src/index.ts`:

```diff
import { createServer, type CreateServerOptions } from "@vue-storefront/middleware";

async function runApp() {
const app = await createServer(config, {
cors: process.env.NODE_ENV === "production" ? undefined : developmentCorsConfig,
+ readinessProbes: []
});
}

```

## 4.3.1

Expand Down
Loading