OpenLiberty / OpenLiberty/docs

Suggested topic (maybe): Switching off dynamic updates

Open
#3,333 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

low priority
Dominant language
No language data
Stars
14
Forks
58
Avg merge
4m
Merged PRs (30d)
35

Description

From reviewing the KC (check with Alasdair for prioritisation).

This topic in the KC:
https://www.ibm.com/support/knowledgecenter/SSAW57_liberty/com.ibm.websphere.wlp.nd.multiplatform.doc/ae/twlp_setup_dyn_upd.html

It makes it seem far more complicated than it is and isn't really relevant to containerised apps (hence the low priority). It's also a badly structured topic (see Alasdair's comments below) that frames the need badly and then duplicates a load of the generated server config info for no real reason. When you take out all that, there's no much left of it. So then the important question is "Do users need to know how to turn off dynamic updates?" If so, that should be what the topic is answering (maybe with a useful config example).

Alasdair's comments as I noted them down when discussing the KC topic:

"Ops[Scenario 3]. Is this relevant to containerised apps? Mostly not because general advice would be to just redeploy docker containers. 90% of the time you probably don’t need dynamic config. however if you change a config map in kube and the configmap contains server config if you turn dynamic behaviour off you need to redeploy the docker containers
I kind of switch on whether that is a good thing or not. 12-factor would say don’t do it. Most people and 12-factor would suggest redeploying docker container. The KC topic includes how to stop doing dynamic updates because you don't need that if you're redeploying a container (also relevant in security hardening context). I wouldn't have the Notes box and instead link to the updateTrigger topic; also don't need the Procedure section because the preamble tells you all you need to know. The Restriction box should be removed. Just simplify this and say if you need to turn off dynamic updates (don't say "default settings"), this is how you'd do it, and show the two pieces of XML. (currently KC gives a lot of words for very little info - makes it feel complicated when it's not)."

Contributor guide

Open the contributing guide

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.

Research direction

Start by reviewing the KC topic on switching off dynamic updates, the generated server config reference, and the updateTrigger reference linked in the issue. Confirm prioritisation and relevance for containerised apps with Alasdair. Done means the topic clearly explains when and how to turn off dynamic updates, includes the two XML configuration pieces, and removes duplicated or unnecessary sections.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.