Skip to content

Commit d8bedb3

Browse files
add limitation documentation (#325)
* add limitation docs * update limitation docs
1 parent 30c985e commit d8bedb3

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

docs/ACM/README_CLUSTER_UPGRADE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
# Upgrade OCP Cluster while Integrity Shield is running
3+
4+
OpenShift Container Platform (OCP) has a cluster upgrade function for an existing OCP cluster, and cluster admins can upgrade their clusters even while Integrity Shield is running.
5+
6+
However, during this upgrade, Kubernetes components such as pods, Kubernetes API server and some others will be unavailable for a while.
7+
8+
So this could make Integrity Shield protection unavailable just for a certain amount of time (a few minutes normally). For details of this limitation, please refer to [this](../README_LIMITATION.md).
9+
10+
Therefore, please note that signature protection would be disabled temporally during OCP cluster upgrade.

docs/README_LIMITATION.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Limitation
2+
3+
## Signature Protection Availability
4+
5+
6+
Integrity Shield provides signature protection to Kubernetes resources and some other artifacts, but there is a limitation in terms of availability.
7+
8+
Integrity Shield monitors Kubernetes resource request like create/update/delete as an admission controller, and an admission controller is connected to Kubernetes API server.
9+
10+
So, when the API server and some other fundamental components are not available, signature protection cannot be performed by Integrity Shield.
11+
12+
For example, when you are trying to upgrade the running cluster, its API server would become unavailable for a while.
13+
14+
During this, signature protection is also unavailable. And after all components get running, it will become available again.
15+

0 commit comments

Comments
 (0)