kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-06-12 01:14:22 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Use flags to specify crawling mode and github user/repo info

Browse Source
This commit is contained in:
Haiyan Meng
2020-01-14 15:36:12 -08:00
parent 7ac573ae51
commit af131c7471
3 changed files with 30 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
api/internal/crawl/config/crawler/job/README.md
View File

@@ -1,4 +1,4 @@
There are three ways of running the crawler job.
The crawler job can run in one of the following mode:
# Crawling all the documents in the index and crawling all the kustomization files on Github
@@ -7,14 +7,13 @@ of the container should be:
```
command: ["/crawler"]
args: []
```
Or
```
command: ["/crawler"]
args: [""]
args: ["--mode=index+github"]
```
# Crawling all the documents in the index
@@ -23,7 +22,7 @@ The `command` and `args` field of the container should be:
```
command: ["/crawler"]
args: ["index"]
args: ["--mode=index"]
```
# Crawling all the kustomization files on Github
@@ -32,7 +31,7 @@ The `command` and `args` field of the container should be:
```
command: ["/crawler"]
args: ["github"]
args: ["--mode=github"]
```
# Crawling all the kustomization files in a Github repo
@@ -41,7 +40,7 @@ The `command` and `args` field of the container should be like:
```
command: ["/crawler"]
args: ["github-repo", "kubernetes-sigs/kustomize"]
args: ["--mode=github-repo", "--github-repo=kubernetes-sigs/kustomize"]
```
# Crawling all the kustomization files in all the repositories of a Github user
@@ -50,5 +49,5 @@ The `command` and `args` field of the container should be like:
```
command: ["/crawler"]
args: ["github-user", "kubernetes-sigs"]
args: ["--github-user", "--github-user=kubernetes-sigs"]
```