Skip to content

Commit

Permalink
docs: update the branch name master to main in the docs (#1058)
Browse files Browse the repository at this point in the history
Signed-off-by: chlins <chenyuzh@vmware.com>
  • Loading branch information
chlins committed Jul 27, 2023
1 parent 4456020 commit 8c7a4a6
Show file tree
Hide file tree
Showing 15 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -661,7 +661,7 @@ $(GORELEASER):

# find or download stringer
# download stringer if necessary
STRINGER_VERSION := v0.1.12
STRINGER_VERSION := v0.11.0
STRINGER := $(BIN)/stringer

.PHONY: stringer
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/bb3adb454b424e66ae3b9bdf2ab2fce1)](https://www.codacy.com/gh/goharbor/harbor-operator/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=goharbor/harbor-operator&amp;utm_campaign=Badge_Grade)
[![Go Reference](https://pkg.go.dev/badge/github.com/goharbor/harbor-operator.svg)](https://pkg.go.dev/github.com/goharbor/harbor-operator)

> **ATTENTIONS:** THE `MASTER` BRANCH MAY BE IN AN UNSTABLE OR EVEN BROKEN STATE DURING DEVELOPMENT.
> **ATTENTIONS:** THE `main` BRANCH MAY BE IN AN UNSTABLE OR EVEN BROKEN STATE DURING DEVELOPMENT.
[Harbor](https://github.com/goharbor/harbor/) is a CNCF hosted open source trusted cloud-native registry project that stores, signs, and scans content. Harbor is composed on numerous stateful and stateless components and dependencies that may be deployed, updated, healed, backuped or scaled respecting some constraints.

Expand Down Expand Up @@ -126,7 +126,7 @@ Harbor operator exposes the frontend service with ingress (CRD version: `v1beta1

## Contributions

Harbor operator project is developed and maintained by the [Harbor operator workgroup](https://github.com/goharbor/community/blob/master/workgroups/wg-operator/README.md). If you're willing to join the group and do contributions to operator project, welcome to [contact us](#community). Follow the [Development guide](https://github.com/goharbor/harbor-operator/blob/master/docs/development.md) to start on the project.
Harbor operator project is developed and maintained by the [Harbor operator workgroup](https://github.com/goharbor/community/blob/main/workgroups/wg-operator/README.md). If you're willing to join the group and do contributions to operator project, welcome to [contact us](#community). Follow the [Development guide](https://github.com/goharbor/harbor-operator/blob/main/docs/development.md) to start on the project.

Special thanks to the [contributors](./MAINTAINERS) who did significant contributions ([see feature area](./docs/feature-areas.md)).

Expand All @@ -136,7 +136,7 @@ Special thanks to the [contributors](./MAINTAINERS) who did significant contribu
* **User Group:** Join Harbor user email group: [harbor-users@lists.cncf.io](https://lists.cncf.io/g/harbor-users) to get update of Harbor's news, features, releases, or to provide suggestion and feedback.
* **Developer Group:** Join Harbor developer group: [harbor-dev@lists.cncf.io](https://lists.cncf.io/g/harbor-dev) for discussion on Harbor development and contribution.
* **Slack:** Join Harbor's community for discussion and ask questions: [Cloud Native Computing Foundation](https://slack.cncf.io/), channel: [#harbor-operator-dev](https://cloud-native.slack.com/messages/harbor-operator-dev/)
* **Community meeting:** attend [bi-weekly community meeting](https://github.com/goharbor/community/blob/master/MEETING_SCHEDULE.md) for Q&A
* **Community meeting:** attend [bi-weekly community meeting](https://github.com/goharbor/community/blob/main/MEETING_SCHEDULE.md) for Q&A

## Additional references

Expand All @@ -150,7 +150,7 @@ Special thanks to the [contributors](./MAINTAINERS) who did significant contribu

## Related links

* Contribute: <https://github.com/goharbor/harbor-operator/blob/master/CONTRIBUTING>
* Contribute: <https://github.com/goharbor/harbor-operator/blob/main/CONTRIBUTING>
* Report bugs: <https://github.com/goharbor/harbor-operator/issues>
* Get latest version: <https://hub.docker.com/r/goharbor/harbor-operator>

Expand All @@ -162,4 +162,4 @@ OVHcloud uses the operator at scale to operate part of its private registry serv

## License

See [LICENSE](https://github.com/goharbor/harbor-operator/blob/master/LICENSE) for licensing details.
See [LICENSE](https://github.com/goharbor/harbor-operator/blob/main/LICENSE) for licensing details.
2 changes: 1 addition & 1 deletion apis/goharbor.io/v1alpha3/core_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ type CoreList struct {
type CoreSpec struct {
harbormetav1.ComponentSpec `json:",inline"`

// https://github.com/goharbor/harbor/blob/master/src/lib/config/metadata/metadatalist.go#L62
// https://github.com/goharbor/harbor/blob/main/src/lib/config/metadata/metadatalist.go#L62
CoreConfig `json:",inline"`

CertificateInjection `json:",inline"`
Expand Down
2 changes: 1 addition & 1 deletion apis/goharbor.io/v1beta1/core_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ type CoreList struct {
type CoreSpec struct {
harbormetav1.ComponentSpec `json:",inline"`

// https://github.com/goharbor/harbor/blob/master/src/lib/config/metadata/metadatalist.go#L62
// https://github.com/goharbor/harbor/blob/main/src/lib/config/metadata/metadatalist.go#L62
CoreConfig `json:",inline"`

CertificateInjection `json:",inline"`
Expand Down
2 changes: 1 addition & 1 deletion charts/harbor-operator/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
export NS={{ .Release.Namespace }}
kubectl get po $POD_NAME -n $NS

2. Apply CRD to create harbor instance, referring to the document: https://github.com/goharbor/harbor-operator/blob/master/docs/CRD/custom-resource-definition.md
2. Apply CRD to create harbor instance, referring to the document: https://github.com/goharbor/harbor-operator/blob/main/docs/CRD/custom-resource-definition.md
4 changes: 2 additions & 2 deletions config/config/assets/jobservice-config.yaml.tmpl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{{/*
https://github.com/goharbor/harbor/blob/master/make/photon/prepare/templates/jobservice/config.yml.jinja
https://github.com/goharbor/harbor/blob/master/src/jobservice/config/config.go#L63
https://github.com/goharbor/harbor/blob/main/make/photon/prepare/templates/jobservice/config.yml.jinja
https://github.com/goharbor/harbor/blob/main/src/jobservice/config/config.go#L63
*/}}
{{- if .Spec.TLS.Enabled }}
protocol: "https"
Expand Down
2 changes: 1 addition & 1 deletion controllers/goharbor/core/deployments.go
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ func (r *Reconciler) GetDeployment(ctx context.Context, core *goharborv1.Core) (
Name: controllers.Core.String(),
Image: image,
Ports: containerPorts,
// https://github.com/goharbor/harbor/blob/master/make/photon/prepare/templates/core/env.jinja
// https://github.com/goharbor/harbor/blob/main/make/photon/prepare/templates/core/env.jinja
Env: envs,
LivenessProbe: &corev1.Probe{
ProbeHandler: corev1.ProbeHandler{
Expand Down
2 changes: 1 addition & 1 deletion controllers/goharbor/harbor/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ func (r *Reconciler) AddRegistryInternalCertificate(ctx context.Context, harbor
}

const (
// https://github.com/goharbor/harbor/blob/master/make/photon/prepare/utils/configs.py#L14
// https://github.com/goharbor/harbor/blob/main/make/photon/prepare/utils/configs.py#L14
RegistryAuthenticationUsername = "harbor_registry_user"

RegistryAuthenticationPasswordLength = 32
Expand Down
2 changes: 1 addition & 1 deletion controllers/goharbor/jobservice/deployments.go
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ func (r *Reconciler) GetDeployment(ctx context.Context, jobservice *goharborv1.J
Image: image,
Ports: containerPorts,

// https://github.com/goharbor/harbor/blob/master/make/photon/prepare/templates/jobservice/env.jinja
// https://github.com/goharbor/harbor/blob/main/make/photon/prepare/templates/jobservice/env.jinja
Env: envs,
LivenessProbe: &corev1.Probe{
ProbeHandler: corev1.ProbeHandler{
Expand Down
2 changes: 1 addition & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ cd harbor-operator

You developped a new cool feature? Fixed an annoying bug? We would be happy to hear from you!

Have a look in [CONTRIBUTING.md](https://github.com/goharbor/harbor-operator/blob/master/CONTRIBUTING.md)
Have a look in [CONTRIBUTING.md](https://github.com/goharbor/harbor-operator/blob/main/CONTRIBUTING.md)

## Dependencies

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/by-helm-chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ you can check the additional references listed below.

Besides, you can also enable the operators of the dependent services in `charts/harbor-operator/values.yaml` to deploy full stack Harbor more efficient.

* Find the configuration items of the dependent operators charts from [here](https://github.com/goharbor/harbor-operator/blob/master/charts/harbor-operator/values.yaml#L252)
* Find the configuration items of the dependent operators charts from [here](https://github.com/goharbor/harbor-operator/blob/main/charts/harbor-operator/values.yaml#L252)

## What's next

Expand Down
4 changes: 2 additions & 2 deletions docs/installation/kustomization-all-in-one.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The installation guide documented here help you deploy Harbor operator stack wit
Directly apply the all-in-one deployment manifest to your Kubernetes cluster:

```shell
kubectl apply -f https://github.com/goharbor/harbor-operator/master/manifests/cluster/deployment.yaml
kubectl apply -f https://github.com/goharbor/harbor-operator/main/manifests/cluster/deployment.yaml
```

>NOTES: Here we use the deployment manifest in the `main` branch as an example, for deploying the released versions, you can get the deployment manifest in the GitHub release page or find it in the corresponding code branch such as `release-1.3.0`.
Expand Down Expand Up @@ -81,7 +81,7 @@ kubectl apply -f customized_deployment.yaml
Delete the harbor operator stack by the deployment manifest:

```shell
kubectl delete -f https://github.com/goharbor/harbor-operator/master/manifests/cluster/deployment.yaml
kubectl delete -f https://github.com/goharbor/harbor-operator/main/manifests/cluster/deployment.yaml
```

Or delete the harbor operator stack by the kustomization template:
Expand Down
4 changes: 2 additions & 2 deletions docs/installation/kustomization-custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ kustomize build | kubectl delete -f -
Deploy the Harbor operator with the deployment manifest:

```shell
kubectl apply -f https://github.com/goharbor/harbor-operator/master/manifests/harbor/deployment.yaml
kubectl apply -f https://github.com/goharbor/harbor-operator/main/manifests/harbor/deployment.yaml
```

Check the Harbor operator status (by default it's deployed into the `harbor-operator-ns` namespace):
Expand All @@ -122,7 +122,7 @@ harbor-operator-76c44d8ddd-z7rgx 1/1 Running 0 80s
For deleting the Harbor operator, call

```shell
kubectl delete -f https://github.com/goharbor/harbor-operator/master/manifests/harbor/deployment.yaml
kubectl delete -f https://github.com/goharbor/harbor-operator/main/manifests/harbor/deployment.yaml
```

Of course, you can clone the codebase into your computer and then customize and deploy with the kustomization template:
Expand Down
4 changes: 2 additions & 2 deletions manifests/cluster/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66211,8 +66211,8 @@ data:
httpport = 8080
jobservice-config.yaml.tmpl: |
{{/*
https://github.com/goharbor/harbor/blob/master/make/photon/prepare/templates/jobservice/config.yml.jinja
https://github.com/goharbor/harbor/blob/master/src/jobservice/config/config.go#L63
https://github.com/goharbor/harbor/blob/main/make/photon/prepare/templates/jobservice/config.yml.jinja
https://github.com/goharbor/harbor/blob/main/src/jobservice/config/config.go#L63
*/}}
{{- if .Spec.TLS.Enabled }}
protocol: "https"
Expand Down
4 changes: 2 additions & 2 deletions manifests/harbor/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44431,8 +44431,8 @@ data:
httpport = 8080
jobservice-config.yaml.tmpl: |
{{/*
https://github.com/goharbor/harbor/blob/master/make/photon/prepare/templates/jobservice/config.yml.jinja
https://github.com/goharbor/harbor/blob/master/src/jobservice/config/config.go#L63
https://github.com/goharbor/harbor/blob/main/make/photon/prepare/templates/jobservice/config.yml.jinja
https://github.com/goharbor/harbor/blob/main/src/jobservice/config/config.go#L63
*/}}
{{- if .Spec.TLS.Enabled }}
protocol: "https"
Expand Down

0 comments on commit 8c7a4a6

Please sign in to comment.