oakestra / oakestra/documentation

Change the default nginx/curl app to one that curls automatically

Open
#64 1 comment 0 reactions 1 assignee View on GitHub

@giobart is already working on this.

Since Mar 10, 2026.

Dominant language
HTML
Stars
0
Forks
3
Avg merge
2h 4m
Merged PRs (30d)
2

Description

Context

Currently, our default demo app/services setup (nginx server & curl client) requires manual intervention for testing networking: the curl client does not automatically initiate requests. To verify connectivity, users must attach to the container via ctr, which is not ideal for a quick demo or for new users.

This has been a recurring pain point, and I would like to propose a minimal change to improve the out-of-the-box experience.

Proposed Change

Update the default curl service command so that it continuously sends requests to the nginx server, making networking tests automatic and observable via logs. Example configuration:

json
"microserviceID": "",
"microservice_name": "curl",
"microservice_namespace": "test",
"virtualization": "container",
"cmd": [
"sh",
"-c",
"while true; do echo --CURL-START--; curl -s http://10.30.30.30/; sleep 5; done"
]

Rationale

The current curl demo app does not actually perform any curl requests by default.

Users must manually attach to the container to test networking, which is not documented and can be confusing.

Updating the default behavior will make demos more intuitive and better aligned with user expectations.

This change would also bring the CLI and documentation in sync with the actual demo experience.

Related Discussion

The current approach may be a legacy from before we had log monitoring, and it seems the SLA example in the docs is outdated.

There is a similar example in the docs (nginx-client-server-with-load-balancing), but the default app does not reflect this improved behavior.
We can and should use the new upgraded default application for the load-balancing example too.
There is no need for a separate SLA.

Action Items

Update the default curl service configuration to automatically curl the nginx server.

Ensure this behavior is reflected in both the CLI and documentation.

Review and update any related screenshots and guides to match the new default behavior.


Image

Image

Image

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.