Bug 1760123
| Summary: | [DOCS 4.1.z] Update snapshot-controller deployment config pod spec to include hostNetwork: true | |||
|---|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Daniel Del Ciancio <ddelcian> | |
| Component: | Documentation | Assignee: | Bob Furu <bfuru> | |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Liang Xia <lxia> | |
| Severity: | medium | Docs Contact: | Vikram Goyal <vigoyal> | |
| Priority: | high | |||
| Version: | 4.1.z | CC: | aos-bugs, bfuru, jokerman | |
| Target Milestone: | --- | Keywords: | Reopened | |
| Target Release: | 4.1.z | |||
| Hardware: | x86_64 | |||
| OS: | Linux | |||
| Whiteboard: | ||||
| Fixed In Version: | Doc Type: | If docs needed, set a value | ||
| Doc Text: | Story Points: | --- | ||
| Clone Of: | ||||
| : | 1762299 (view as bug list) | Environment: | ||
| Last Closed: | 2019-11-04 19:18:53 UTC | Type: | Bug | |
| Regression: | --- | Mount Type: | --- | |
| Documentation: | --- | CRM: | ||
| Verified Versions: | Category: | --- | ||
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | ||
| Cloudforms Team: | --- | Target Upstream Version: | ||
| Embargoed: | ||||
| Bug Depends On: | ||||
| Bug Blocks: | 1762299 | |||
|
Description
Daniel Del Ciancio
2019-10-09 22:15:36 UTC
The following section: https://docs.openshift.com/container-platform/4.1/storage/persistent-storage/persistent-storage-snapshots.html#snapshots-starting-controller-provisioner_persistent-storage-snapshots should be modified to include this command after creating the serviceaccount : # oc adm policy add-scc-to-user hostnetwork -z snapshot-controller-runner Since the pod runs using snapshot-controller-runner serviceaccount, it requires the hostnetwork scc assigned it. Also, the "AWS authentication" section [https://docs.openshift.com/container-platform/4.1/storage/persistent-storage/persistent-storage-snapshots.html#aws-authentication], it should state something like "when generating the base64 values required for the awskeys secret, make sure to remove any trailing newline character as follows: echo -n "<aws_access_key_id>" | base64 echo -n "<aws_secret_access_key>" | base64 Can we be sure to have the documentation reflect this as well? Thanks! The restore section in [1] should also reflect the following changes:
# When using AWS EBS storage with gp2 encryption configured, you need to explicitly set the parameters below:
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: snapshot-promoter
provisioner: volumesnapshot.external-storage.k8s.io/snapshot-promoter
parameters:
encrypted: "true"
type: gp2
# The restore snapshot should specify the accessModes and resources attributes:
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: snapshot-pv-provisioning-demo
annotations:
snapshot.alpha.kubernetes.io/snapshot: snapshot-demo
spec:
storageClassName: snapshot-promoter
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
Lastly, the 4.1 doc states that volume snapshots is tech preview, however, the 4.2 doc (still unpublished) states that this feature will be deprecated. Can you clarify? Will it be replaced with a storage operator?
-----
[1] https://docs.openshift.com/container-platform/4.1/storage/persistent-storage/persistent-storage-snapshots.html#persistent-storage-snapshots-restore_persistent-storage-snapshots
Docs updated to reflect Daniel's suggestions. Created PR 17438 (https://github.com/openshift/openshift-docs/pull/17438). Waiting for SME review and also QE review. Updating to ON_QA. The doc looks good. --> Waiting for SME review BZ 1762299 is a clone of this bug. Confirming with reporter that content updates are the same for both bugs, and that once approved, this will be merged, CP to 4.1 and 4.2 only (not 4.3). SME reviewed and approved. Out for peer review. Hi Bob - feedback provided in PR 17438 (https://github.com/openshift/openshift-docs/pull/17438). Looks good for the most part, just a small precision suggested to denote that in the example provided, the snapshot-controller is deployed in "default" namespace. Namespace references should be specific to the appropriate namespace where deployed to. Thanks, Daniel. I've added annotations for "default" namespace as described in this comment: https://github.com/openshift/openshift-docs/pull/17438#issuecomment-547633291. PR 17438 approved. Peer reviewed and merged and CP to 4.1, 4.2, 4.3. Waiting to verify on prod. *** Bug 1762299 has been marked as a duplicate of this bug. *** Verified on docs.openshift.com. Closing bug. QE re-verified, waiting for SME (Daniel) approval before closing. SME approved and merged, CP to 4.1, 4.2, 4.3 on docs.openshift.com and portal. 4.2 https://docs.openshift.com/container-platform/4.2/storage/persistent-storage/persistent-storage-snapshots.html#persistent-storage-snapshots-restore_persistent-storage-snapshots https://access.redhat.com/documentation/en-us/openshift_container_platform/4.2/html-single/storage/index 4.1 https://docs.openshift.com/container-platform/4.1/storage/persistent-storage/persistent-storage-snapshots.html#persistent-storage-snapshots-restore_persistent-storage-snapshots https://access.redhat.com/documentation/en-us/openshift_container_platform/4.1/html-single/storage/index Will publish in 4.3 docs upon release. Closing bug. (In reply to Bob Furu from comment #21) > SME approved and merged, CP to 4.1, 4.2, 4.3 on docs.openshift.com and > portal. > > 4.2 > https://docs.openshift.com/container-platform/4.2/storage/persistent-storage/ > persistent-storage-snapshots.html#persistent-storage-snapshots- > restore_persistent-storage-snapshots > https://access.redhat.com/documentation/en-us/openshift_container_platform/4. > 2/html-single/storage/index > > 4.1 > https://docs.openshift.com/container-platform/4.1/storage/persistent-storage/ > persistent-storage-snapshots.html#persistent-storage-snapshots- > restore_persistent-storage-snapshots > https://access.redhat.com/documentation/en-us/openshift_container_platform/4. > 1/html-single/storage/index > > Will publish in 4.3 docs upon release. Closing bug. PR (https://github.com/openshift/openshift-docs/pull/17784) reviewed and approved. |