Update external links. (#1946)

* Update doc links.

Signed-off-by: Maya Rashish <mrashish@redhat.com>

* Remove reference for travis-ci, no longer used

Signed-off-by: Maya Rashish <mrashish@redhat.com>

* Follow links and update links

Signed-off-by: Maya Rashish <mrashish@redhat.com>
This commit is contained in:
Maya Rashish 2021-09-22 15:16:30 +03:00 committed by GitHub
parent addf25b4f9
commit a2fd370a0d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 18 additions and 19 deletions

View File

@ -18,7 +18,7 @@ As an add-on to Kubernetes, CDI shares some philosophy and design choices:
* Declarative and Reactive (Operator pattern) approach
This short page shall help to get started with the projects and topics
surrounding them. If you notice a strong similarity with the [KubeVirt contribution guidelines](https://github.com/kubevirt/kubevirt/blob/master/CONTRIBUTING.md) it's because we have taken inspiration from their success.
surrounding them. If you notice a strong similarity with the [KubeVirt contribution guidelines](https://github.com/kubevirt/kubevirt/blob/main/CONTRIBUTING.md) it's because we have taken inspiration from their success.
## Contributing to CDI
@ -79,7 +79,7 @@ Before your PR can be merged it must meet the following criteria:
* [README.md](README.md) has been updated if core functionality is affected.
* Complex features need standalone documentation in [doc/](doc/).
* Functionality must be fully tested. Unit test code coverage as reported by
[Goveralls](https://coveralls.io/github/kubevirt/containerized-data-importer?branch=master)
[Goveralls](https://coveralls.io/github/kubevirt/containerized-data-importer?branch=main)
must not decrease unless justification is given (ie. you're adding generated
code).

View File

@ -1,6 +1,5 @@
# Containerized Data Importer
[![Build Status](https://travis-ci.org/kubevirt/containerized-data-importer.svg?branch=master)](https://travis-ci.org/kubevirt/containerized-data-importer)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubevirt/containerized-data-importer)](https://goreportcard.com/report/github.com/kubevirt/containerized-data-importer)
[![Coverage Status](https://img.shields.io/coveralls/kubevirt/containerized-data-importer/master.svg)](https://coveralls.io/github/kubevirt/containerized-data-importer?branch=master)
[![Licensed under Apache License version 2.0](https://img.shields.io/github/license/kubevirt/containerized-data-importer.svg)](https://www.apache.org/licenses/LICENSE-2.0)

View File

@ -13,7 +13,7 @@ Each one is useful for different use cases, which we will explain below. Note th
Manual hostPath based storage is basically a mapping between a path on the host to a PV. This is the simplest form of storage and should be a good starting point. If you are trying CDI with [minikube](https://github.com/kubernetes/minikube) we will provide an example to get started.
#### minikube example
The contents here are directly taken from the [minikube persistent volume documentation](https://github.com/kubernetes/minikube/blob/master/docs/persistent_volumes.md) and we encourage you to read and understand that document.
The contents here are directly taken from the [minikube persistent volume documentation](https://minikube.sigs.k8s.io/docs/handbook/persistent_volumes/) and we encourage you to read and understand that document.
```yaml
apiVersion: v1
@ -32,7 +32,7 @@ spec:
This will create a 5Gi sized PV, and now you are ready to apply one of the many [examples](../manifests/example) to this PV. If you run
```bash
kubectl create -f https://github.com/kubevirt/containerized-data-importer/blob/master/manifests/example/import-kubevirt-datavolume.yaml
kubectl create -f https://github.com/kubevirt/containerized-data-importer/blob/main/manifests/example/import-kubevirt-datavolume.yaml
```
It will create a Data Volume (DV) and import a cirros virtual disk image to that DV. If you try some of the other examples you might find that some of them require [scratch space](scratch-space.md). To create scratch space you simply need another PV available and CDI will automatically make use of it while importing. For cloning you will also need two PVs, one that contains the source data, and one that will be the target.

View File

@ -2,15 +2,15 @@
The purpose of this document is to show how to create registry image containing a Virtual Machine image that can be imported into a PV.
## Prerequisites
Import from registry should be able to consume the same container images as [containerDisk](https://github.com/kubevirt/kubevirt/blob/master/docs/container-register-disks.md).
Import from registry should be able to consume the same container images as [containerDisk](https://github.com/kubevirt/kubevirt/blob/main/docs/container-register-disks.md).
Thus the VM disk image file to be consumed must be located under /disk directory in the container image. The file can be in any of the supported formats : qcow2, raw, archived image file. There are no special naming constraints for the VM disk file.
## Import VM disk image file from existing containerDisk images in kubevirt repository
For example vmidisks/fedora25:latest as described in [containerDisk](https://github.com/kubevirt/kubevirt/blob/master/docs/container-register-disks.md)
For example vmidisks/fedora25:latest as described in [containerDisk](https://github.com/kubevirt/kubevirt/blob/main/docs/container-register-disks.md)
## Create a container image with Buildah
Buildah is a tool that facilitates building Open Container Initiative (OCI) container images.
More information is available here: [Buildah tutorial](https://github.com/containers/buildah/blob/master/docs/tutorials/02-registries-repositories.md).
More information is available here: [Buildah tutorial](https://github.com/containers/buildah/blob/main/docs/tutorials/02-registries-repositories.md).
Create a new directory `/tmp/vmdisk` with the following Docker file and a vm image file (ex: `fedora28.qcow2`)
Create a new container image with the following docker file

View File

@ -225,7 +225,7 @@ redeploy the manifests above, and re-run the tests.
### Submit PRs
All PRs should originate from forks of kubevirt.io/containerized-data-importer. Work should not be done directly in the upstream repository. Open new working branches from master/HEAD of your forked repository and push them to your remote repo. Then submit PRs of the working branch against the upstream master branch.
All PRs should originate from forks of kubevirt.io/containerized-data-importer. Work should not be done directly in the upstream repository. Open new working branches from main/HEAD of your forked repository and push them to your remote repo. Then submit PRs of the working branch against the upstream main branch.
### Releases

View File

@ -31,8 +31,8 @@ import (
)
const (
//containerDiskImageDir - Expected disk image location in container image as described in
//https://github.com/kubevirt/kubevirt/blob/master/docs/container-register-disks.md
// containerDiskImageDir - Expected disk image location in container image as described in
// https://github.com/kubevirt/kubevirt/blob/main/docs/container-register-disks.md
containerDiskImageDir = "disk"
)

View File

@ -473,7 +473,7 @@ _The CDI Operator does not support updates yet._
Links: []csvv1.AppLink{
{
Name: "CDI",
URL: "https://github.com/kubevirt/containerized-data-importer/blob/master/README.md",
URL: "https://github.com/kubevirt/containerized-data-importer/blob/main/README.md",
},
{
Name: "Source Code",

View File

@ -8,7 +8,7 @@ import (
"k8s.io/kube-openapi/pkg/common"
)
// code stolen/adapted from https://github.com/kubevirt/kubevirt/blob/master/pkg/util/openapi/openapi.go
// code stolen/adapted from https://github.com/kubevirt/kubevirt/blob/main/pkg/util/openapi/openapi.go
func createOpenAPIConfig(webServices []*restful.WebService) restfulspec.Config {
return restfulspec.Config{

View File

@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
// Retrieved from https://github.com/kubevirt/kubevirt/blob/master/pkg/version/base.go
// Retrieved from https://github.com/kubevirt/kubevirt/blob/main/staging/src/kubevirt.io/client-go/version/base.go
package version

View File

@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
// Retrieved from https://github.com/kubevirt/kubevirt/blob/master/pkg/version/types.go
// Retrieved from https://github.com/kubevirt/kubevirt/blob/main/staging/src/kubevirt.io/client-go/version/types.go
package version

View File

@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
// Used https://github.com/kubernetes/kubernetes/blob/master/pkg/version/verflag/verflag.go as a template
// Used https://github.com/kubernetes/component-base/blob/master/version/verflag/verflag.go as a template
// Package verflag defines utility functions to handle command line flags
// related to version of CDI.

View File

@ -66,7 +66,7 @@ var _ = Describe("ALL Operator tests", func() {
Expect(scc.Users).Should(ContainElement(cdiSA))
})
// Condition flags can be found here with their meaning https://github.com/kubevirt/hyperconverged-cluster-operator/blob/master/docs/conditions.md
// Condition flags can be found here with their meaning https://github.com/kubevirt/hyperconverged-cluster-operator/blob/main/docs/conditions.md
It("[test_id:3953]Condition flags on CR should be healthy and operating", func() {
cdiObjects, err := f.CdiClient.CdiV1beta1().CDIs().List(context.TODO(), metav1.ListOptions{})
Expect(err).ToNot(HaveOccurred())

View File

@ -32,7 +32,7 @@ import (
cdiv1 "kubevirt.io/containerized-data-importer/pkg/apis/core/v1beta1"
)
// code stolen/adapted from https://github.com/kubevirt/kubevirt/blob/master/pkg/virt-api/rest/definitions.go
// code stolen/adapted from https://github.com/kubevirt/kubevirt/blob/main/pkg/virt-api/rest/definitions.go
const (
mimeJSON string = "application/json"

View File

@ -18,7 +18,7 @@
*/
// this file directly copy/pasted from KubeVirt project here:
// https://github.com/kubevirt/kubevirt/blob/master/tools/util/marshaller.go
// https://github.com/kubevirt/kubevirt/blob/main/tools/util/marshaller.go
package util