Skip to content

Commit

Permalink
Updated Links
Browse files Browse the repository at this point in the history
  • Loading branch information
cheina97 committed Nov 5, 2023
1 parent 2e8aeb9 commit 66d6f92
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 8 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,10 @@ jobs:
persist-credentials: false

- name: Check the validity of the links in the documentation
uses: gaurav-nelson/github-action-markdown-link-check@v1
uses: gaurav-nelson/github-action-markdown-link-check@1.0.15
with:
use-quiet-mode: 'yes'


shell-lint:
name: Lint shell files
runs-on: ubuntu-latest
Expand Down
9 changes: 9 additions & 0 deletions .markdownlink.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"httpHeaders": [
{
"urls": ["https://linux.die.net"],
"headers": {
}
}
]
}
2 changes: 1 addition & 1 deletion infrastructure/certificate-provisioning/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ In different scenarios, it may happen to have different `Ingress` resources in d

### Install kubed

Kubed can be easily installed with helm [[5]](https://appscode.com/products/kubed/latest/setup/install/).
Kubed can be easily installed with helm [[5]](https://appscode.com/products/kubed/v0.12.0/setup/install/).

```bash
helm repo add appscode https://charts.appscode.com/stable/
Expand Down
2 changes: 1 addition & 1 deletion infrastructure/monitoring/loki-promtail/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ With the **memberlist** configuration, the information is shared between the rep
working_directory: /data/loki/boltdb-shipper-compactor
shared_store: s3 #filesystem
```
You can choose where you want to store the data, either in the local filesystem (PVC) or in a S3 object store. For the latter, you must configure the S3 bucket parameters as indicated. Some examples of Loki configurations are also available [here](https://grafana.com/docs/loki/latest/configuration/examples/#loki-configuration-examples).
You can choose where you want to store the data, either in the local filesystem (PVC) or in a S3 object store. For the latter, you must configure the S3 bucket parameters as indicated. Some examples of Loki configurations are also available [here](https://grafana.com/docs/loki/latest/configure/examples/).
*NOTE: some buckets, for example AWS, want the region before the BUCKET_HOST. So the full S3 path is s3://<ACCESS_KEY>:<SECRET_ACCESS_KEY>@REGION_BUKET.BUCKET_HOST/BUCKET_NAME*.
Expand Down
2 changes: 1 addition & 1 deletion operators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ The two main limitations of this approach are the following:

If the request for a new snapshot is valid, a new Job is created that performs the following two main actions:

- **Export the VM's disk**: this action is done by an init container in the job; it steals the DataVolume from the VM and converts the above raw disk image in a QCOW2 image, using the [QEMU disk image utility](https://qemu.readthedocs.io/en/latest/tools/qemu-img.html). After the conversion, it creates the Dockerfile for the Docker image build, which is needed in the next step.
- **Export the VM's disk**: this action is done by an init container in the job; it steals the DataVolume from the VM and converts the above raw disk image in a QCOW2 image, using the [QEMU disk image utility](https://qemu.readthedocs.io/en/master/tools/qemu-img.html). After the conversion, it creates the Dockerfile for the Docker image build, which is needed in the next step.
- **Build a new image and push it to the Docker registry**: once the init container terminates successfully, an EmptyDir volume with the building context is ready to be used for building the image and pushing it to the registry. This job leverages [Kaniko](https://github.com/GoogleContainerTools/kaniko), which allows to build a Docker image without a privileged container, since all the commands in the Dockerfile are executed in userspace. Note that Kaniko requires a large amount of RAM during the building process, so make sure that the RAM memory limit in your namespace is enough (currently the Kaniko container has a RAM memory limit of 32GB).

When the snapshot creation process successfully terminates, the docker registry will contain a new VM image with the exact copy of the target persistent VM at the moment of the snapshot creation. Note that before being able to create a new VM instance with that image, you should first create a new Template with the newly uploaded image.
Expand Down
2 changes: 1 addition & 1 deletion provisioning/standalone/vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The **base image** contained in the `./base` folder is an image that contains on

### Set Dockerfile

Starting from the [Base Version](#base-version) it is possible to develop a customized image.
Starting from the [Base Version](basic-version) it is possible to develop a customized image.

1. **Create** a new **Dockerfile**
2. **Include** the base version Dockerfile using **Dockerfile+**'s `INCLUDE+` directive (see more [**here**](https://github.com/edrevo/dockerfile-plus.git))
Expand Down
5 changes: 3 additions & 2 deletions provisioning/virtual-machines/README-VM-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ sudo sudo adduser <your_user> docker
newgrp docker
```

<a name="ansible"></a>
(Ansible)=

## Installing software packages with Ansible: overview

The `setup-crownlabs-vms.sh` script makes use of Ansible Playbooks to install additional software packages in the VM (e.g., applications that you need to run in the guest OS).
Expand Down Expand Up @@ -71,7 +72,7 @@ The tools that are required by CrownLabs to work and are automatically installed

3. Once the installation terminates and the OS completes the reboot, issue `./setup-crownlabs-vm.sh <vm-name> configure <ansible-playbook.yml> (--vbox-only)`, where the _playbook_ contains the instructions to configure and install the additional software packages you need to run in the VM.
The script connects to the VM via SSH and runs the specified ansible playbook.
For more detailed instructions about creating and customizing Ansible playbook, look at the [dedicated subsection](#ansible).
For more detailed instructions about creating and customizing Ansible playbook, look at the [dedicated subsection](Ansible).

**NOTE**: if the command is executed with no additional parameters, the scripts assumes that the VM is going to be used in CrownLabs and proceeds with the installation of the tools required for its operations. The `--vbox-only` flag tells the script to opt out this configuration and prepares vanilla VMs meant to be used directly in VirtualBox, as well as exported in the *.ova* format.

Expand Down

0 comments on commit 66d6f92

Please sign in to comment.