Browse Source

Increase s3 driver support

Change-Id: I8e75982c2daf0af1e37e88e3e3bee857f33b6907
Implements: blueprint s3-driver-support
Pengju Jiao 1 year ago
parent
commit
8879e781ad
1 changed files with 142 additions and 0 deletions
  1. 142
    0
      specs/pike/approved/s3_driver_support.rst

+ 142
- 0
specs/pike/approved/s3_driver_support.rst View File

@@ -0,0 +1,142 @@
1
+..
2
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
3
+ License.
4
+
5
+ http://creativecommons.org/licenses/by/3.0/legalcode
6
+
7
+=========================
8
+S3 storage driver support
9
+=========================
10
+
11
+* https://blueprints.launchpad.net/freezer/+spec/s3-driver-support
12
+
13
+Provide more storage media options for users to store the backup data.
14
+
15
+Problem description
16
+===================
17
+
18
+Currently, freezer can only store backup data to swift compatible object
19
+storage (except local and ssh), so we should increase support for other storage
20
+driver. S3 compatible object storage is a valid choice, which is used by many
21
+individuals and companies in the public or private clouds. With S3 driver,
22
+freezer can store backup data in S3 compatible object storage, such as AWS S3
23
+or ceph S3 interface.
24
+
25
+Use Cases
26
+---------
27
+
28
+* Users that want to backup data to S3 compatible object storage.
29
+
30
+* OpenStack distributions deployed without swift module.
31
+
32
+Proposed change
33
+===============
34
+
35
+Implement in the freezer-agent a new storage type called 's3'.
36
+
37
+With specifying the 's3' storage type, the authentication parameters and the
38
+S3 endpoint, backup data will be stored on S3 compatible storage after the
39
+backup finished.
40
+
41
+Alternatives
42
+------------
43
+
44
+None
45
+
46
+Technical details
47
+-----------------
48
+
49
+Related docs:
50
+
51
+Amazon S3 REST API Introduction
52
+* http://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html
53
+
54
+The python client module that could be used is boto3
55
+* https://github.com/boto/boto3
56
+
57
+Data model impact
58
+-----------------
59
+
60
+None
61
+
62
+REST API impact
63
+---------------
64
+
65
+None
66
+
67
+Security impact
68
+---------------
69
+
70
+None
71
+
72
+Notifications impact
73
+--------------------
74
+
75
+Some message log will be added.
76
+
77
+Other end user impact
78
+---------------------
79
+
80
+None
81
+
82
+Performance Impact
83
+------------------
84
+
85
+None
86
+
87
+Other deployer impact
88
+---------------------
89
+
90
+* A new storage type called 's3' will be added.
91
+* When specify 's3' type, 'access-key', 'secret-key' and 'endpoint' should be
92
+required.
93
+
94
+Developer impact
95
+----------------
96
+
97
+None
98
+
99
+Implementation
100
+==============
101
+
102
+Assignee(s)
103
+-----------
104
+
105
+Primary assignee:
106
+  Pengju Jiao <jiaopengju@cmss.chinamobile.com>
107
+
108
+Work Items
109
+----------
110
+
111
+* Implementing the new storage driver (S3)
112
+
113
+* Bundling the storage driver to freezer-agent
114
+
115
+
116
+Dependencies
117
+============
118
+
119
+None
120
+
121
+
122
+Testing
123
+=======
124
+
125
+None
126
+
127
+Documentation Impact
128
+====================
129
+
130
+Some instructions should be added to tell users how to use S3 storage driver.
131
+
132
+
133
+References
134
+==========
135
+
136
+None
137
+
138
+
139
+History
140
+=======
141
+
142
+None

Loading…
Cancel
Save