Upstream/harbor
1
0
Fork 0
mirror of https://github.com/goharbor/harbor.git synced 2024-11-25 11:46:43 +01:00
Code Issues Projects Releases Wiki Activity

add video demo references (both youtube and v.qq)to the readme.md and the user guide

Browse Source
This commit is contained in:
Steven Zou 2017-09-27 12:33:41 +08:00
parent 546a8327aa
commit 07b6934c9d
9 changed files with 20 additions and 276 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -40,6 +40,13 @@ More info on [partners and users](partners.md).
### Contribution
We welcome contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a pull request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq). Contact us for any questions: harbor @vmware.com .
### Demos
* ![play](docs/img/video.png) **Content Trust** ( [youtube](https://www.youtube.com/watch?v=pPklSTJZY2E) [v.qq](https://v.qq.com/x/page/n0553fzzrnf.html) )
* ![play](docs/img/video.png) **Role Based Access Control** ( [youtube](https://www.youtube.com/watch?v=2ZIu9XTvsC0) [v.qq](https://v.qq.com/x/page/l0553yw19ek.html) )
* ![play](docs/img/video.png) **Vulnerability Scanning** ( [youtube](https://www.youtube.com/watch?v=K4tJ6B2cGR4) [v.qq](https://v.qq.com/x/page/s0553k9692d.html) )
* ![play](docs/img/video.png) **Image Replication** ( [youtube](https://www.youtube.com/watch?v=1NPlzrm5ozE) [v.qq](https://v.qq.com/x/page/a0553wc7fs9.html) )
* ![play](docs/img/video.png) **VMworld 2017** ( [youtube](https://www.youtube.com/watch?v=tI5xMe24fJ4) )
### License
Harbor is available under the [Apache 2 license](LICENSE).

BIN
docs/img/video.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.4 KiB

10
docs/user_guide.md
View File

@ -31,6 +31,8 @@ Besides the above three roles, there are two system-wide roles:
* **SysAdmin**: "SysAdmin" has the most privileges. In addition to the privileges mentioned above, "SysAdmin" can also list all projects, set an ordinary user as administrator, delete users and set vulnerability scan policy for all images. The public project "library" is also owned by the administrator.
* **Anonymous**: When a user is not logged in, the user is considered as an "Anonymous" user. An anonymous user has no access to private projects and has read-only access to public projects.
See video demo: [youtube](https://www.youtube.com/watch?v=2ZIu9XTvsC0) [v.qq](https://v.qq.com/x/page/l0553yw19ek.html)
## User account
Harbor supports two authentication modes:
@ -105,6 +107,8 @@ Click a rule, jobs which belong to this rule will be listed. A job represents th
![browse project](img/new_rule_list.png)
See video demo: [youtube](https://www.youtube.com/watch?v=1NPlzrm5ozE) [v.qq](https://v.qq.com/x/page/a0553wc7fs9.html)
## Searching projects and repositories
Entering a keyword in the search field at the top lists all matching projects and repositories. The search result includes both public and private repositories you have access to.
@ -254,6 +258,8 @@ If you are using a self-signed cert, make sure to copy the CA cert into ```/etc/
When an image is signed, it has a tick shown in UI; otherwise, a cross sign(X) is displayed instead.
![browse project](img/content_trust.png)
See video demo: [youtube](https://www.youtube.com/watch?v=pPklSTJZY2E) [v.qq](https://v.qq.com/x/page/n0553fzzrnf.html)
### Vulnerability scanning via Clair
**CAUTION: Clair is an optional component, please make sure you have already installed it in your Harbor instance before you go through this section.**
@ -320,4 +326,6 @@ You can set policies to control the vulnerability analysis process. Currently, t
* **Daily:** Policy is activated daily. It means an analysis job is scheduled to be executed at the specified time everyday. The scheduled job will scan all the images in Harbor.
![browse project](img/scan_policy.png)
**NOTES: Once the scheduled job is executed, the completion time of scanning all images will be updated accordingly. Please be aware that the completion time of the images may be different because the execution of analysis for each image may be carried out at different time.**
**NOTES: Once the scheduled job is executed, the completion time of scanning all images will be updated accordingly. Please be aware that the completion time of the images may be different because the execution of analysis for each image may be carried out at different time.**
See video demo: [youtube](https://www.youtube.com/watch?v=K4tJ6B2cGR4) [v.qq](https://v.qq.com/x/page/s0553k9692d.html)

19
src/ui_ng/CODE_OF_CONDUCT.md
View File

@ -1,19 +0,0 @@
Contributor Code of Conduct
======================
As contributors and maintainers of the Clarity project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities.
Communication through any of Clarity's channels (GitHub, mailing lists, Twitter, and so on) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
We promise to extend courtesy and respect to everyone involved in this project, regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the Clarity project to do the same.
If any member of the community violates this code of conduct, the maintainers of the Clarity project may take action, including removing issues, comments, and PRs or blocking accounts, as deemed appropriate.
If you are subjected to or witness unacceptable behavior, or have any other concerns, please communicate with us.
If you have suggestions to improve this Code of Conduct, please submit an issue or PR.
**Attribution**
This Code of Conduct is adapted from the Angular project, version 0.3a-angular, available at this page: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md

113
src/ui_ng/CONTRIBUTING.md
View File

@ -1,113 +0,0 @@
# Contributing to clarity-seed
The clarity-seed project team welcomes contributions from the community. Follow the guidelines to contribute to the seed.
## Contribution Guidelines
Before you start working with Clarity, please complete the following steps:
- Read our [code of conduct](/CODE_OF_CONDUCT.md).
- Read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.
## Contribution Flow
Here are the typical steps in a contributor's workflow:
- [Fork](https://help.github.com/articles/fork-a-repo/) the main Clarity seed repository.
- Clone your fork and set the upstream remote to the main Clarity repository.
- Set your name and e-mail in the Git configuration for signing.
- Create a topic branch from where you want to base your work.
- Make commits of logical units.
- Make sure your commit messages are in the proper format (see below).
- Push your changes to a topic branch in your fork of the repository.
- [Submit a pull request](https://help.github.com/articles/about-pull-requests/).
Example:
``` shell
# Clone your forked repository
git clone git@github.com:<github username>/clarity-seed.git
# Navigate to the directory
cd clarity-seed
# Set name and e-mail configuration
git config user.name "John Doe"
git config user.email johndoe@example.com
# Setup the upstream remote
git remote add upstream https://github.com/vmware/clarity-seed.git
# Create a topic branch for your changes
git checkout -b my-new-feature master
# After making the desired changes, commit and push to your fork
git commit -a -s
git push origin my-new-feature
```
### Staying In Sync With Upstream
When your branch gets out of sync with the master branch, use the following to update:
``` shell
git checkout my-new-feature
git fetch -a
git pull --rebase upstream master
git push --force-with-lease origin my-new-feature
```
### Updating Pull Requests
If your PR fails to pass CI, or requires changes based on code review, you'll most likely want to squash these changes into existing commits.
If your pull request contains a single commit, or your changes are related to the most recent commit, you can amend the commit.
``` shell
git add .
git commit --amend
git push --force-with-lease origin my-new-feature
```
If you need to squash changes into an earlier commit, use the following:
``` shell
git add .
git commit --fixup <commit>
git rebase -i --autosquash master
git push --force-with-lease origin my-new-feature
```
Make sure you add a comment to the PR indicating that your changes are ready to review. GitHub does not generate a notification when you use git push.
### Formatting Commit Messages
Use this format for your commit message:
```
<detailed commit message>
<BLANK LINE>
<reference to closing an issue>
<BLANK LINE>
Signed-off-by: Your Name <your.email@example.com>
```
#### Writing Guidelines
These documents provide guidance creating a well-crafted commit message:
* [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/)
* [Closing Issues Via Commit Messages](https://help.github.com/articles/closing-issues-via-commit-messages/)
## Reporting Bugs and Creating Issues
You can submit an issue or a bug to our [GitHub repository](https://github.com/vmware/clarity-seed/issues). You must provide:
* Instruction on how to replicate the issue
* The version number of Angular
* The version number of Clarity
* The version number of Node
* The browser name and version number
* The OS running the seed

16
src/ui_ng/Clarity Seed_LICENSE_MIT.txt
View File

@ -1,16 +0,0 @@
Clarity Seed
Copyright © 2016 VMware, Inc. All rights reserved
The MIT license (the “License”) set forth below applies to all parts of the Clarity Seed project. You may not use this file except in compliance with the License. 
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

8
src/ui_ng/Clarity Seed_NOTICE.txt
View File

@ -1,8 +0,0 @@
Clarity Seed
Copyright (c) 2016 VMware, Inc. All Rights Reserved.
This product is licensed to you under the MIT license (the "MIT License"). You may not use this product except in compliance with the MIT License.
This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.

122
src/ui_ng/README.md
View File

@ -1,121 +1,5 @@
![Clarity](logo.png)
![Harbor UI](../../docs/img/harbor_logo.png)
Clarity Seed
Harbor UI
============
This is a seed project for Angular 2 applications using [Clarity](https://github.com/vmware/clarity). For more information on the Clarity Design System, visit the [Clarity website](https://vmware.github.io/clarity/).
We offer this seed project in three different build systems:
1. **Angular-CLI version (branch: master)**
2. Webpack 2 version (branch: webpack)
3. SystemJS version (branch: systemjs)
Getting started
----------------------------------
#### Angular-CLI version
This seed version provides the following out of the box:
- Angular 2 application with [clarity-icons](https://www.npmjs.com/package/clarity-icons), [clarity-ui](https://www.npmjs.com/package/clarity-ui) and [clarity-angular](https://www.npmjs.com/package/clarity-angular) included
- Development and production builds
- Unit test setup with Jasmine and Karma
- End-to-end test setup with Protractor
- SASS processor
- TSLint
- And other goodies that come with [Angular-CLI](https://github.com/angular/angular-cli#generating-and-serving-an-angular2-project-via-a-development-server) (v1.0.0-beta.20-4)
#### Installation
*Prerequisite*: Please install Angular-CLI by following [these instructions](https://github.com/angular/angular-cli#installation).
*Note*: Even though it's optional, we recommend you to use [yarn](https://yarnpkg.com/) instead of `npm install` for installing the dependencies.
```bash
git clone https://github.com/vmware/clarity-seed.git
cd clarity-seed
# install the project's dependencies
yarn # or run "npm install"
# starts the application in dev mode and watches your files for livereload
ng serve
```
#### Using Angular-CLI
```bash
# generating a new component
ng g component my-new-component
# generating a new directive
ng g directive my-new-directive
# to learn more about Angular-CLI commands and their usages
ng help
```
For comprehensive documentation on Angular-CLI, please see their [github repository](https://github.com/angular/angular-cli).
#### Test and build scripts
```bash
# running unit tests
ng test
# running e2e tests
ng e2e
# dev build
ng build
# prod build
ng build --prod
```
## Documentation
For documentation on the Clarity Design System, including a list of components and example usage, see [our website](https://vmware.github.io/clarity).
#### Directory structure
```
.
├── README.md
├── karma.conf.js <- configuration of the test runner
├── package.json <- dependencies of the project
├── protractor.config.js <- e2e tests configuration
├── src/ <- source code of the application
│   ├── app/
│   │   └── component/
│   │   └── <component>.component.html
│   │   └── <component>.component.scss
│   │   └── <component>.component.spec.ts
│   │   └── <component>.component.ts
│   │   └── app.component.html
│   │   └── app.component.scss
│   │   └── app.component.ts
│   │   └── app.e2e-spec.js <- sample e2e spec file
│   │   └── app.module.ts
│   │   └── app.routing.ts
│   │   └── main.ts <- boostrap file for the angular app
│   └── index.html
├── angular-cli.json <- configuration of the angular-cli
├── tsconfig.json <- configuration of the typescript project
├── tslint.json <- sample configuration file for tslint
└── yarn.lock
```
## Contributing
The Clarity project team welcomes contributions from the community. For more detailed information, see [CONTRIBUTING.md](CONTRIBUTING.md).
## License
The clarity-seed project is licensed under the MIT license.
## Feedback
If you find a bug or want to request a new feature, please open a [GitHub issue](https://github.com/vmware/clarity-seed/issues).
This is the project based on Clarity and Angular to build Harbor UI.

1
src/ui_ng/lib/README.md
View File

@ -1,5 +1,6 @@
# Harbor UI library
**NOTES: Odd version is development version and may be not stable. Even version is release version which should be stable.**
![Harbor UI Library](../../../docs/img/harbor_logo.png)
Wrap the following Harbor UI components into a sharable library and published as npm package for other third-party applications to import and reuse.