Skip to content

Commit faf4cc9

Browse files
committed
feat: add uffizzi usage docs
Signed-off-by: Vibhav Bobade <vibhav.bobde@gmail.com>
1 parent c668d0f commit faf4cc9

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Using Uffizzi
3+
---
4+
5+
6+
## Variables
7+
8+
Variable | Description
9+
-------------------|-------------
10+
BASEIMAGETAG | The tag for base image, default:dev
11+
VERSIONTAG | The tag for harbor image, default:dev
12+
DEVFLAG | Build model flag, default: true
13+
GOBUILDIMAGE | Golang image to compile harbor go source code.
14+
TRIVYFLAG | Whether to enable trivy in harbor, default:false
15+
CHARTFLAG | Whether to enable chartmuseum in harbor, default:false
16+
HTTPPROXY | Clarity proxy to build UI.
17+
18+
## Targets
19+
20+
Target | Description
21+
--------------------|-------------
22+
all | prepare env, compile binaries, build images and install images
23+
prepare | prepare env
24+
compile | compile core and jobservice code
25+
compile_core | compile core binary
26+
compile_jobservice | compile jobservice binary
27+
build | build Harbor docker images
28+
build_base_docker | build Harbor docker base images
29+
install | compile binaries, build images, prepare specific version of compose file and startup Harbor instance
30+
start | startup Harbor instance
31+
down | shutdown Harbor instance
32+
package_online | prepare online install package
33+
package_offline | prepare offline install package
34+
pushimage | push Harbor images to specific registry server
35+
cleanall | remove binary, Harbor images, specific version docker-compose file, specific version tag and online/offline install package
36+
cleanbinary | remove core and jobservice binary
37+
cleanimage | remove Harbor images
38+
cleandockercomposefile | remove specific version docker-compose
39+
cleanpackage | remove online/offline install package
40+
41+
## Examples
42+
43+
### Build and run harbor from source code
44+
45+
```sh
46+
make install
47+
```
48+
49+
### Package offline installer
50+
51+
```sh
52+
make package_offline
53+
```

0 commit comments

Comments
 (0)