Skip to content

Commit 1058b8f

Browse files
committed
README.md: Added instructions for development setup
Signed-off-by: Kamoltat Sirivadhna <[email protected]>
1 parent 1e6d5ad commit 1058b8f

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,3 +152,47 @@ export TEUTHOLOGY_TESTNODES="smithiXXX.front.sepia.ceph.com,smithiYYY.front.sepi
152152
export TEUTHOLOGY_MACHINE_TYPE="smithi"
153153
```
154154

155+
### Setup for development
156+
157+
1. First fork the repo if you have not done so.
158+
2. Clone your forked repo
159+
160+
```bash
161+
git clone https://github.com/<user-name>/ceph-devstack
162+
```
163+
164+
3. Setup the remote repo as upstream (this will prevent creating additional branches)
165+
166+
```bash
167+
git remote add upstream https://github.com/zmc/ceph-devstack
168+
```
169+
170+
4. Create virtual env in the root directory of ceph-devstack & install python dependencies
171+
172+
```bash
173+
python3 -m venv venv
174+
./venv/bin/pip3 install -e .
175+
```
176+
177+
5. Set owner for /dev/loop-control
178+
```bash
179+
sudo chown $(whoami) /dev/loop-control
180+
```
181+
182+
6. activate venv
183+
```bash
184+
source venv/bin/activate
185+
```
186+
187+
7. Run doctor command to fix any thing we missed
188+
```bash
189+
ceph-devstack -v doctor --fix
190+
```
191+
192+
8. Build, Create and Start the containers
193+
```bash
194+
ceph-devstack -v build
195+
ceph-devstack -v create
196+
ceph-devstack -v start
197+
```
198+

0 commit comments

Comments
 (0)