Skip to content

Improved documentation for ServerSideApply #6784

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

Merged
merged 2 commits into from
Jan 14, 2025
Merged

Improved documentation for ServerSideApply #6784

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ad685f
Updated ServerSideApply section of CHEATSHEET.md
cowwoc Jan 13, 2025
f2bf111
Update doc/CHEATSHEET.md
manusa Jan 14, 2025
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
10 changes: 4 additions & 6 deletions doc/CHEATSHEET.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2393,18 +2393,16 @@ try (KubernetesClient client = new KubernetesClientBuilder().build()) {

#### Server Side Apply

Basic usage of server side apply is available via Patchable. At it's simplest you just need to call:
To create a new resource or update an existing one, you just need to call:

```java
client.services().withName("name").patch(PatchContext.of(PatchType.SERVER_SIDE_APPLY), service);
DeploymentConfig dc = client.deploymentConfigs().inNamespace("default").resource(dcToCreate).serverSideApply();
```

For any create or update. This can be a good alternative to using createOrReplace as it is always a single api call and does not issue a replace/PUT which can be problematic.

If the resources may be created or modified by something other than a fabric8 patch, you will need to force your modifications:
For resources that are updated by other [FieldManagers](https://kubernetes.io/docs/reference/using-api/server-side-apply/#managers), you will need to force your modifications:

```java
client.services().withName("name").patch(new PatchContext.Builder().withPatchType(PatchType.SERVER_SIDE_APPLY).withForce(true).build(), service);
DeploymentConfig dc = client.deploymentConfigs().inNamespace("default").resource(dcToCreate).forceConflicts().serverSideApply();
```

Please consult the Kubernetes server side apply documentation if you want to do more detailed field management or want to understand the full semantics of how the patches are merged.
Expand Down