DO280 - ch07s07

Bookmark this page

Lab: Manage Kubernetes Operators

Install an operator and verify that it is healthy.

Outcomes

Install the Compliance operator on the command line.

As the student user on the workstation machine, use the lab command to prepare your system for this exercise.

This command ensures that the cluster API is reachable and that the operator that is used in this exercise is not present.

[student@workstation ~]$ lab start operators-review

Instructions

In this exercise, you install the Compliance operator. For more information, refer to the Compliance Operator chapter in the Red Hat OpenShift Container Platform 4.14 Security and Compliance documentation at https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html-single/security_and_compliance/index#compliance-operator.

[student@workstation ~]$ oc login -u admin -p redhatocp \
    https://api.ocp4.example.com:6443
Login successful.

...output omitted...

Examine the package manifest for the Compliance operator to discover the operator name, catalog name, suggested namespace, and channel.

Use the oc command to list the package manifest resources.

[student@workstation ~]$ oc get packagemanifest
NAME                      CATALOG                     AGE
lvms-operator             do280 Operator Catalog Cs   2d5h
file-integrity-operator   do280 Operator Catalog Cs   2d5h
metallb-operator          do280 Operator Catalog Cs   2d5h
compliance-operator       do280 Operator Catalog Cs   2d5h
kubevirt-hyperconverged   do280 Operator Catalog Cs   2d5h

Examine the compliance-operator package manifest.

[student@workstation ~]$ oc get packagemanifest compliance-operator -o yaml
apiVersion: packages.operators.coreos.com/v1
kind: PackageManifest
metadata:
  creationTimestamp: "2024-01-24T14:05:27Z"
  labels:
    catalog: do280-catalog-cs
    catalog-namespace: openshift-marketplace
...output omitted...
  name: compliance-operator
  namespace: default
spec: {}
status:
...output omitted...
  channels:
  - currentCSV: compliance-operator.v1.4.0
    currentCSVDesc:
      annotations:
        alm-examples: |-
...output omitted...
        operatorframework.io/suggested-namespace: openshift-compliance
...output omitted...
      version: 1.4.0
    name: stable
  defaultChannel: stable
  packageName: compliance-operator
...output omitted...

The package manifest contains the following information:

Field	Value
`catalog`	`do280-catalog-cs`
`catalog-namespace`	`openshift-marketplace`
`suggested-namespace`	`openshift-compliance`
`defaultChannel`	`stable`
`packageName`	`compliance-operator`

Create the recommended openshift-compliance namespace.

Use the oc command to create the namespace.

[student@workstation ~]$ oc create namespace openshift-compliance
namespace/openshift-compliance created

Create an operator group with the compliance-operator name in the openshift-compliance namespace. The target namespace of the operator group is the openshift-compliance namespace. You can use the ~/DO280/labs/operators-review/operator-group.yaml file as a template.
Create an operator-group.yaml file with the following content:
apiVersion: operators.coreos.com/v1 kind: OperatorGroup metadata: name: compliance-operator namespace: openshift-compliance spec: targetNamespaces: - openshift-compliance
Use the oc command to create the operator group:
[student@workstation ~]$ oc create -f operator-group.yaml operatorgroup.operators.coreos.com/compliance-operator created
Create a compliance-operator subscription in the openshift-compliance namespace. The subscription has the following parameters:
Field Value
channel stable
spec.name compliance-operator
source do280-catalog-cs
sourceNamespace openshift-marketplace
You can use the ~/DO280/labs/operators-review/subscription.yaml file as a template.
You can configure automatic install plan approvals.
Create a subscription.yaml file with the following content:
apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: compliance-operator namespace: openshift-compliance spec: channel: stable installPlanApproval: Automatic name: compliance-operator source: do280-catalog-cs sourceNamespace: openshift-marketplace
Use the oc command to create the operator group:
[student@workstation ~]$ oc create -f subscription.yaml subscription.operators.coreos.com/compliance-operator created
Wait until the operator is installed.
The Operator Lifecycle Manager creates a cluster service version in the openshift-compliance namespace. Wait until the cluster service version resource (CSV) is in the Succeeded phase.
Although the CSV defines a single compliance-operator deployment, the operator has two additional deployments. Wait until the compliance-operator, ocp4-openshift-compliance-pp, and rhcos4-openshift-compliance-pp deployments are ready.
Select the openshift-compliance project.
[student@workstation ~]$ oc project openshift-compliance Now using project "openshift-compliance" on server "https://api.ocp4.example.com:6443".
Wait until the CSV is in the Succeeded phase.
[student@workstation ~]$ oc get csv NAME DISPLAY VERSION ... PHASE compliance-operator.v1.4.0 Compliance Operator 1.4.0 ... Succeeded ...output omitted...
The available CSV version in the lab might change. Commands in the following steps require you to replace the available version in the lab.
Inspect the CSV to view the operator deployment. Replace the version that you obtained in a previous step. The .spec.install.spec.deployments JSONPath expression describes the location of the operator deployments in the CSV resource. Optionally, use the jq command to indent the output.
[student@workstation ~]$ oc get csv compliance-operator.v1.4.0 \ -o jsonpath={.spec.install.spec.deployments} | jq [ { "name": "compliance-operator", "spec": { ...output omitted...
The Compliance operator describes a single deployment with the compliance-operator name.
Use the oc command to list the workloads in the operator namespace.
[student@workstation ~]$ oc get all NAME ... pod/compliance-operator-... ... pod/ocp4-openshift-compliance-pp-... ... pod/rhcos4-openshift-compliance-pp-... ... ...output omitted... NAME READY ... deployment.apps/compliance-operator 1/1 ... deployment.apps/ocp4-openshift-compliance-pp 1/1 ... deployment.apps/rhcos4-openshift-compliance-pp 1/1 ... ...output omitted...
Besides the compliance-operator deployment, the Compliance operator creates two other deployments.
Wait until all deployments are ready.
Verify that the operator works correctly.
This operator watches custom resources of the ScanSettingBinding type and runs file integrity checks on cluster nodes. The operator reports results with custom resources of the ComplianceSuite type.
Create a scan setting binding in the openshift-compliance namespace. You can use the ~/DO280/labs/operators-review/scan-setting-binding.yaml file as a template.
You can also use the web console to create the scan setting binding. The YAML editor in the web console provides the same scan setting binding resource as an example.
Wait until a resource of the ComplianceSuite type in the DONE phase is present in the openshift-compliance namespace.
Examine the alm-examples annotation in the CSV. Replace the version that you obtained in a previous step.
[student@workstation ~]$ oc get csv compliance-operator.v1.4.0 \ -o jsonpath={.metadata.annotations.alm-examples} | jq [ ...output omitted... { "apiVersion": "compliance.openshift.io/v1alpha1", "kind": "ScanSettingBinding", "metadata": { "name": "nist-moderate" }, "profiles": [ { "apiGroup": "compliance.openshift.io/v1alpha1", "kind": "Profile", "name": "rhcos4-moderate" } ], "settingsRef": { "apiGroup": "compliance.openshift.io/v1alpha1", "kind": "ScanSetting", "name": "default" } }, ...output omitted... ]
The annotation contains an example scan setting binding that you can use. The example is in JSON format. When creating a scan setting binding in the web console, the YAML editor loads the same example.
You can also use the oc explain command to describe the scan setting binding resource.
Create the scan setting binding resource by using the example file in the ~/DO280/labs/operators-review/scan-setting-binding.yaml path.
[student@workstation ~]$ oc create \ -f ~/DO280/labs/operators-review/scan-setting-binding.yaml scansettingbinding.compliance.openshift.io/nist-moderate created
Use the oc command to list compliance suite and pod resources. Execute the command repeatedly until the compliance suite resource is in the DONE phase.
[student@workstation ~]$ oc get compliancesuite,pod NAME PHASE RESULT compliancesuite.compliance.openshift.io/nist-moderate DONE NON-COMPLIANT NAME ... pod/compliance-operator-... ... pod/ocp4-openshift-compliance-pp-... ... pod/rhcos4-openshift-compliance-pp-... ...
To execute the scan, the compliance operator creates extra pods. The pods disappear when the scan completes.

Field	Value
`channel`	`stable`
`spec.name`	`compliance-operator`
`source`	`do280-catalog-cs`
`sourceNamespace`	`openshift-marketplace`

Evaluation

As the student user on the workstation machine, use the lab command to grade your work. Correct any reported failures and rerun the command until successful.

[student@workstation ~]$ lab grade operators-review

Finish

As the student user on the workstation machine, use the lab command to complete this exercise. This step is important to ensure that resources from previous exercises do not impact upcoming exercises.

[student@workstation ~]$ lab finish operators-review

Discuss Red Hat OpenShift Administration II: Configuring a Production Cluster

Go to community

Red Hat OpenShift Administration II: Operating a Production Kubernetes Cluster (DO280)

Haley_Ruccio

26 lip 2023

Configure, manage, and troubleshoot OpenShift clusters and containerized applicationsRed Hat OpenShift Administration II: Operating a Production Kubernetes Cluster (DO280) prepares OpenShift Cluster Administrators to perform daily administration tasks on clusters that host applications provided by internal teams and external vendors, enable self-service for cluster users with different roles, and deploy applications that require special permissions such as such as CI/CD tooling, performance monitoring, and security scanners. This course focuses on configuring multi-tenancy and security features of OpenShift as well as managing OpenShift add-ons based on operators.The skills you learn in this course can be applied using all versions of OpenShift, including Red Hat OpenShift on AWS (ROSA), Azure Red Hat OpenShift, and OpenShift Container Platform.This course is based on OpenShift Container Platform 4.12.5-10 Course TopicsDeploying packaged applications using manifests, templates, kustomize, and helm.Configuring authentication and authorization for users and applications.Protecting network traffic with network policies and exposing applications with proper network access.Deploying and managing applications using resources manifests.Enabling developer self-service of application projects.Managing OpenShift cluster updates and Kubernetes operator updates.Target AudienceSystem Administrators and Platform Operators interested in the ongoing management of OpenShift clusters, applications, users, and add-ons.Site Reliability Engineers interested in the ongoing maintenance and troubleshooting of Kubernetes clusters.System and Software Architects interested in understanding the security of an OpenShift cluster.Recommended TrainingTake our free assessment to gauge whether this offering is the best fit for your skills.Prerequisite: Red Hat OpenShift I: Containers & Kubernetes (DO180 v4.12), or equivalent skills deploying and managing Kubernetes applications using the OpenShift web console and command-line interfaces.Technology considerationsThis course requires internet access to access the cloud-based classroom environment that provides an OpenShift cluster and a remote administrator’s workstation.

476

About pod security standards and warnings

alexcorcoles

17 kwi 2023

(This material has been created with the inputs of instructors and other people. We are trying to get this material published as soon as possible to address some concerns with DO180 and DO280.)With the default configuration, any namespace that you create on OpenShift 4.12 has the following labels: pod-security.kubernetes.io/audit: restrictedpod-security.kubernetes.io/audit-version: v1.24pod-security.kubernetes.io/warn: restrictedpod-security.kubernetes.io/warn-version: v1.24 These labels activate auditing and warning of the restricted pod security standard. The Kubernetes documentation describes the restricted pod security standard. Pod security standards such as restricted are not directly related to security context constraints such as the restricted SCC.Kubernetes uses an admission controller to reject pods that do not comply with pod security standards. An admission controller is a Kubernetes component that inspects every Kubernetes resource before its creation, and acts before Kubernetes creates the resource. This action can include rejecting the creation of the resource, or modifying the resource.The pod security standards are policies that include properties that workloads must follow. For example, the restricted standard requires that containers set the securityContext.allowPrivilegeEscalation field to false.Pod security standards apply both to workloads, such as deployments and jobs, and to pods.When a pod is created, the admission controller inspects the container specifications and enumerates the fields that violate the pod security standard of the namespace. The admission controller inspects the pod-security labels in the namespace to decide which pod security standard to apply (restricted, baseline, or privileged), and which action to take on violations. Namespaces can audit, warn, or enforce pod security standard violations. When the pod-security.kubernetes.io/audit annotation is set to restricted, the admission controller prevents the creation of pods that violate the security standard. When the pod-security.kubernetes.io/audit and pod-security.kubernetes.io/warn annotations are defined in the project, the admission controller does not block the creation of pods, but registers audit events or warnings.The admission controller does not enforce pod security standards for workloads. If the namespace is configured to enforce a pod security standard, then you can create a violating workload. The admission controller enforces only pod security policies on pods.Cluster administrators can use pod security standards to ensure that pods and workloads in namespaces limit their privileges. By limiting privileges, cluster administrators can mitigate what malicious pods can do.The default configuration of user namespaces in OpenShift does not restrict any workload; it only notifies users when they create workloads that do not follow pod security standards that might be enforced in future OpenShift versions.Security Context ConstraintsOpenShift introduced security context constraints (SCC) before the introduction of pod security standards in Kubernetes. SCCs automatically make security modifications to pods when they are created. By default, the system:openshift:scc:restricted-v2 cluster role binding applies to all authenticated users, so regular user workloads use the restricted-v2 SCC. For example, when you execute the following command to create a workload without any security configuration, the SCC adds security configuration to the pods: [user@host ~]$ oc create deployment test --image registry.ocp4.example.com:8443/redhattraining/hello-world-nginx (You can add the --dry-run=client -o yaml options to view the deployment manifest. The deployment manifest does not contain the security properties, which are described later.)If you inspect the pods that the deployment created, the SCC makes the following changes: [user@host ~]$ oc get pod test-b8d5658b6-7bxfs -o yamlapiVersion: v1kind: Podmetadata: annotations:... output omitted... openshift.io/scc: restricted-v2 seccomp.security.alpha.kubernetes.io/pod: runtime/default...output omitted...spec: containers: - image: registry.ocp4.example.com:8443/redhattraining/hello-world-nginx imagePullPolicy: Always name: hello-world-nginx resources: {} securityContext: allowPrivilegeEscalation: false capabilities: drop: - ALL runAsNonRoot: true runAsUser: 1000690000... output omitted... securityContext: fsGroup: 1000690000 seLinuxOptions: level: s0:c26,c20 seccompProfile: type: RuntimeDefault... output omitted... These restrictions satisfy the restricted pod security policy.The result of these defaults means that when creating a workload (such as a deployment) in a namespace without any customization, the restricted pod security standard applies, but the admission controller only warns and audits. If the workload does not satisfy the pod security standard, then the admission controller allows the workload to be created, but prints a message such as the following warning: Warning: would violate PodSecurity "restricted:v1.24": allowPrivilegeEscalation != false (container "example" must set securityContext.allowPrivilegeEscalation=false), unrestricted capabilities (container "example" must set securityContext.capabilities.drop=["ALL"]), runAsNonRoot != true (pod or container "database" must set securityContext.runAsNonRoot=true), seccompProfile (pod or container "example" must set securityContext.seccompProfile.type to "RuntimeDefault" or "Localhost") However, by default Kubernetes creates the deployment pods with the restricted-v2 SCC, with the restrictions that the previous warning included. Due to the following factors, workloads generate only a warning, and the pod security standard admission controller allows their pods:The pod security standard admission controller never enforces pod security standards on workloads (only on pods).By default, namespaces do not enforce pod security standards on pods.By default, regular workloads create pods by using the restricted-v2 SCC, which satisfies the restricted pod security standard.Even if future versions of OpenShift change the default namespace configuration to enforce the restricted pod security standard, users will continue to be able to create workloads without explicitly declaring the restrictions that the pod security standard requires, because the restricted-v2 SCC will apply such restrictions automatically.You can take the following approaches to handling pod security:For most workloads, the restricted-v2 SCC limits pod privileges adequately. When creating a workload, you receive the warning, but the workload creates pods and works correctly.You can also create your workloads by providing a full specification of the security constraints to apply, without relying on the SCC to provide the configuration. By following this approach, privileges are more explicit, and you have greater control, so you can adjust more precisely the specific privileges that are granted to workloads.When the restricted-v2 SCC and the default restricted pod security standard are not adequate for your workload, because either you require further privileges, or you need further restrictions, you must use an existing SCC, or create a custom SCC, and provide explicit security specifications. You can also adjust the namespace labels to choose a different pod security standard, and decide to audit, log, or enforce the standard.

1473

Welcome to the Red Hat OpenShift Administration II (DO280) group in the Red Hat Learning Community!

Deanna

17 kwi 2023

We are excited to launch a space dedicated to the Red Hat Training course Red Hat OpenShift Administration II: Operating a Production Kubernetes Cluster!To gain the most value from this group - click the "Join Group" button in the upper right hand corner.We encourage group members to collaborate in this group to discuss topics, ask questions, share best practices and tips, provide course feedback, and share their accomplishments as it relates to DO280.Read more about Red Hat OpenShift Administration II here.Thanks!

1334

Revision: do280-4.14-08d11e1