Skip to content

Commit dcd059c

Browse files
akarolakarol
committed
Add S3 Certification Process Requirements documentation
- Add comprehensive S3CERTIFY.md guide for S3-compatible storage certification - Include access requirements, credentials, endpoint configuration - Add support and communication guidelines - Provide certification timeline and process overview - Include quick checklist and contact information - Document applies to OADP 1.3+ and OpenShift 4.12+
1 parent 9bfd582 commit dcd059c

File tree

1 file changed

+159
-0
lines changed

1 file changed

+159
-0
lines changed

‎S3CERTIFY.md‎

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
# S3 Certification Process Requirements
2+
3+
> **OpenShift API for Data Protection (OADP)**
4+
> S3-Compatible Object Storage Certification Guide
5+
6+
---
7+
8+
## 📋 Table of Contents
9+
10+
- [Overview](#overview)
11+
- [I. Access and Environment Requirements](#i-access-and-environment-requirements)
12+
- [II. Support and Communication](#ii-support-and-communication)
13+
- [III. Certification Process and Timeline](#iii-certification-process-and-timeline)
14+
- [Quick Checklist](#quick-checklist)
15+
- [Getting Started](#getting-started)
16+
- [Contact Information](#contact-information)
17+
18+
---
19+
20+
## Overview
21+
22+
This document outlines the general requirements, access needs, and steps involved in certifying an **S3-compatible object storage product** for use with **OADP (OpenShift API for Data Protection)**.
23+
24+
> ⚠️ **Important**: This certification process ensures your S3-compatible storage solution meets the reliability and compatibility standards required for production OpenShift backup and restore operations.
25+
26+
### 📋 **Currently Supported S3-Compatible Providers**
27+
28+
OADP currently supports the following S3-compatible storage solutions:
29+
30+
📖 **[View Currently Supported S3-Compatible Storage Providers](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/backup_and_restore/oadp-application-backup-and-restore#oadp-s3-compatible-backup-storage-providers_about-installing-oadp)** - Official Red Hat documentation listing all certified providers.
31+
32+
---
33+
34+
## I. Access and Environment Requirements
35+
36+
### 🪣 1. S3 Bucket Access
37+
38+
- **Dedicated Bucket**: Provision an S3 bucket dedicated to certification testing
39+
- **Minimum Capacity**: The bucket should have a minimum capacity of **10GB** to accommodate test workloads
40+
- **Configuration Access**: Ensure the ability to modify bucket settings, including features such as:
41+
- Object locking
42+
- Versioning
43+
- Lifecycle policies
44+
- Access control
45+
46+
### 🔐 2. Credentials
47+
48+
#### UI Access
49+
- Provide credentials (**username** and **password**) for accessing the product's management interface
50+
51+
#### CLI Access
52+
- Provide an **Access Key** and **Secret Key** for use with CLI-based testing
53+
- Ensure keys have sufficient permissions for backup/restore operations
54+
55+
> 🔒 **Security Note**: All credentials will be handled securely and used only for certification testing.
56+
57+
### 🌐 3. S3 Endpoint
58+
59+
- **Stable Endpoint**: A stable and reachable S3 endpoint URL must be provided
60+
```
61+
Example: https://s3.your-storage.com
62+
```
63+
- **Fixed IP Resolution**: The endpoint should resolve to a fixed IP address
64+
65+
### 🔒 4. SSL Certificates
66+
67+
- **SSL Verification**: If SSL verification is enforced, provide:
68+
- Certificate installation procedure **OR**
69+
- Root certificate installation steps needed to establish trust for the endpoint
70+
71+
---
72+
73+
## II. Support and Communication
74+
75+
### 💬 Support Channel
76+
- Establish a clear communication channel for addressing technical questions and issues during testing:
77+
- **Email** support channel
78+
- **Slack** workspace access
79+
- **Other** preferred communication method
80+
81+
### 👥 Points of Contact
82+
83+
| Role | Responsibility |
84+
|------|----------------|
85+
| **Technical Contact** | Configuration and debugging assistance |
86+
| **Support Contact** | Escalations or environment issues |
87+
88+
---
89+
90+
## III. Certification Process and Timeline
91+
92+
### ⏱️ Duration
93+
- **Estimated Timeline**: The certification process typically completes within **3–4 weeks**
94+
- **Dependencies**: Timeline depends on:
95+
- Environment readiness
96+
- Issue turnaround time
97+
- Response time for technical queries
98+
99+
### 🎯 Certification Outcome
100+
Upon successful validation, the product will be **listed as a supported S3-compatible backup storage provider** in the official OADP documentation:
101+
102+
📖 **[S3-Compatible Backup Storage Providers - OpenShift Container Platform Documentation](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/backup_and_restore/oadp-application-backup-and-restore#oadp-certified-backup-storage-providers_about-installing-oadp)**
103+
104+
This inclusion provides:
105+
- **Official Red Hat support recognition**
106+
- **Customer confidence** in your storage solution
107+
- **Technical validation** for enterprise deployments
108+
- **Integration guidance** for OpenShift users
109+
110+
### 🔗 Endpoint Availability
111+
112+
#### Temporary Endpoints
113+
- **Current Testing**: Temporary endpoints (valid for a few weeks) are sufficient for testing current OADP releases
114+
115+
#### Permanent Endpoints *(Recommended)*
116+
- **Future Validation**: For ongoing validation and future OADP versions.
117+
- **Requirement**: Permanent and stable endpoint preferred
118+
119+
120+
## 📝 Quick Checklist
121+
122+
Use this checklist to ensure all requirements are met before starting certification:
123+
124+
- [ ] **S3 Bucket**: 10GB+ dedicated bucket provisioned
125+
- [ ] **UI Credentials**: Username/password for management interface
126+
- [ ] **CLI Credentials**: Access Key/Secret Key provided
127+
- [ ] **Endpoint**: Stable S3 endpoint URL available
128+
- [ ] **SSL**: Certificate trust established (if required)
129+
- [ ] **Support Channel**: Communication method established
130+
- [ ] **Contacts**: Technical and support contacts identified
131+
- [ ] **Timeline**: 3-4 week certification window confirmed
132+
133+
---
134+
135+
## 🤝 Getting Started
136+
137+
To initiate the S3 certification process:
138+
139+
1. **Review Requirements**: Ensure all items in the checklist above are completed
140+
2. **Contact OADP Team**: Reach out to begin the certification process
141+
3. **Environment Setup**: Provide access credentials and endpoint information
142+
4. **Testing Phase**: Collaborate during the 3-4 week testing period
143+
5. **Documentation**: Upon success, your product will be added to supported providers
144+
145+
---
146+
147+
## 📞 Contact Information
148+
149+
For questions or to begin the S3 certification process:
150+
151+
- **OADP Team**: [[email protected]](mailto:[email protected]),[[email protected]](mailto:[email protected])
152+
- **GitHub Issues**: [OADP Operator Repository](https://github.com/openshift/oadp-operator/issues)
153+
154+
---
155+
156+
> 📄 **Document Version**: 1.0
157+
> **Last Updated**: October 7, 2025
158+
159+

0 commit comments

Comments
 (0)