Skip to content

feat: support setting securityContext for plugin side-car containers #25

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
Agalin merged 1 commit into from
Sep 15, 2025
Merged

feat: support setting securityContext for plugin side-car containers #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions api/v1/archive_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ type InstanceSidecarConfiguration struct {
// Resources allocated for the sidecar
// +optional
Resources corev1.ResourceRequirements `json:"resources,omitempty"`
// SecurityContext for the sidecar container
// +optional
SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty"`
}

// ArchiveSpec defines the desired state of Archive.
Expand Down
5 changes: 5 additions & 0 deletions api/v1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

192 changes: 192 additions & 0 deletions config/crd/bases/pgbackrest.cnpg.opera.com_archives.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,198 @@ spec:
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type: object
type: object
securityContext:
description: SecurityContext for the sidecar container
properties:
allowPrivilegeEscalation:
description: |-
AllowPrivilegeEscalation controls whether a process can gain more
privileges than its parent process. This bool directly controls if
the no_new_privs flag will be set on the container process.
AllowPrivilegeEscalation is true always when the container is:
1) run as Privileged
2) has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows.
type: boolean
appArmorProfile:
description: |-
appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
description: |-
localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost".
type: string
type:
description: |-
type indicates which kind of AppArmor profile will be applied.
Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement.
type: string
required:
- type
type: object
capabilities:
description: |-
The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
items:
description: Capability represent POSIX capabilities
type
type: string
type: array
x-kubernetes-list-type: atomic
drop:
description: Removed capabilities
items:
description: Capability represent POSIX capabilities
type
type: string
type: array
x-kubernetes-list-type: atomic
type: object
privileged:
description: |-
Run container in privileged mode.
Processes in privileged containers are essentially equivalent to root on the host.
Defaults to false.
Note that this field cannot be set when spec.os.name is windows.
type: boolean
procMount:
description: |-
procMount denotes the type of proc mount to use for the containers.
The default value is Default which uses the container runtime defaults for
readonly paths and masked paths.
This requires the ProcMountType feature flag to be enabled.
Note that this field cannot be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
description: |-
Whether this container has a read-only root filesystem.
Default is false.
Note that this field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
description: |-
The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
description: |-
Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
description: |-
The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
description: |-
The SELinux context to be applied to the container.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label that applies
to the container.
type: string
role:
description: Role is a SELinux role label that applies
to the container.
type: string
type:
description: Type is a SELinux type label that applies
to the container.
type: string
user:
description: User is a SELinux user label that applies
to the container.
type: string
type: object
seccompProfile:
description: |-
The seccomp options to use by this container. If seccomp options are
provided at both the pod & container level, the container options
override the pod options.
Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
description: |-
localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet's configured seccomp profile location.
Must be set if type is "Localhost". Must NOT be set for any other type.
type: string
type:
description: |-
type indicates which kind of seccomp profile will be applied.
Valid options are:

Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied.
type: string
required:
- type
type: object
windowsOptions:
description: |-
The Windows specific settings applied to all containers.
If unspecified, the options from the PodSecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
description: |-
GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name of the
GMSA credential spec to use.
type: string
hostProcess:
description: |-
HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true.
type: boolean
runAsUserName:
description: |-
The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
type: string
type: object
type: object
type: object
required:
- configuration
Expand Down
32 changes: 28 additions & 4 deletions internal/cnpgi/operator/lifecycle.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,21 @@ func (impl LifecycleImplementation) calculateSidecarResources(
return nil
}

func (impl LifecycleImplementation) calculateSidecarSecurityContext(
ctx context.Context,
archive *pgbackrestv1.Archive,
) *corev1.SecurityContext {
contextLogger := log.FromContext(ctx).WithName("lifecycle")

if archive != nil && archive.Spec.InstanceSidecarConfiguration.SecurityContext != nil {
contextLogger.Info("Loading sidecar security context definition from the archive object.")
return archive.Spec.InstanceSidecarConfiguration.SecurityContext
}

contextLogger.Info("Security context definition not found in the archive object, using default (no restrictions).")
return nil
}

func (impl LifecycleImplementation) getArchives(
ctx context.Context,
namespace string,
Expand Down Expand Up @@ -223,8 +238,9 @@ func (impl LifecycleImplementation) reconcileJob(
return nil, err
}
resources := impl.calculateSidecarResources(ctx, recoveryArchive)
securityContext := impl.calculateSidecarSecurityContext(ctx, recoveryArchive)

return reconcileJob(ctx, cluster, request, env, resources)
return reconcileJob(ctx, cluster, request, env, resources, securityContext)
}

func reconcileJob(
Expand All @@ -233,6 +249,7 @@ func reconcileJob(
request *lifecycle.OperatorLifecycleRequest,
env []corev1.EnvVar,
resources *corev1.ResourceRequirements,
securityContext *corev1.SecurityContext,
) (*lifecycle.OperatorLifecycleResponse, error) {
contextLogger := log.FromContext(ctx).WithName("lifecycle")
if pluginConfig := cluster.GetRecoverySourcePlugin(); pluginConfig == nil || pluginConfig.Name != metadata.PluginName {
Expand Down Expand Up @@ -268,7 +285,7 @@ func reconcileJob(
corev1.Container{
Args: []string{"restore"},
},
env, resources,
env, resources, securityContext,
); err != nil {
return nil, fmt.Errorf("while reconciling pod spec for job: %w", err)
}
Expand Down Expand Up @@ -299,8 +316,9 @@ func (impl LifecycleImplementation) reconcilePod(
return nil, err
}
resources := impl.calculateSidecarResources(ctx, archive)
securityContext := impl.calculateSidecarSecurityContext(ctx, archive)

return reconcilePod(ctx, cluster, request, pluginConfiguration, env, resources)
return reconcilePod(ctx, cluster, request, pluginConfiguration, env, resources, securityContext)
}

func reconcilePod(
Expand All @@ -310,6 +328,7 @@ func reconcilePod(
pluginConfiguration *config.PluginConfiguration,
env []corev1.EnvVar,
resources *corev1.ResourceRequirements,
securityContext *corev1.SecurityContext,
) (*lifecycle.OperatorLifecycleResponse, error) {
pod, err := decoder.DecodePodJSON(request.GetObjectDefinition())
if err != nil {
Expand All @@ -329,7 +348,7 @@ func reconcilePod(
corev1.Container{
Args: []string{"instance"},
},
env, resources,
env, resources, securityContext,
); err != nil {
return nil, fmt.Errorf("while reconciling pod spec for pod: %w", err)
}
Expand All @@ -355,6 +374,7 @@ func reconcilePodSpec(
sidecarConfig corev1.Container,
additionalEnvs []corev1.EnvVar,
resources *corev1.ResourceRequirements,
securityContext *corev1.SecurityContext,
) error {
envs := []corev1.EnvVar{
{
Expand Down Expand Up @@ -428,6 +448,10 @@ func reconcilePodSpec(
sidecarConfig.Resources = *resources
}

if securityContext != nil {
sidecarConfig.SecurityContext = securityContext
}

if err := InjectPluginSidecarPodSpec(spec, &sidecarConfig, mainContainerName, true); err != nil {
return err
}
Expand Down
Loading