Skip to content

Commit afea2a2

Browse files
Merge branch 'master' into release-4-5-c
2 parents 158a658 + 6316af1 commit afea2a2

File tree

13 files changed

+94
-187
lines changed

13 files changed

+94
-187
lines changed

.dockerignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@ screenshots/
99
tests/screenshot.spec.ts-snapshots/
1010
tests-results/
1111
playwright-report/
12+
.docusaurus/
13+
.git
14+
.github

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ src/deprecated
66
vale/
77
**/*.yaml
88
**/*.yml
9+
.dockerignore
910

1011
docs/api-content/**/*.json
1112

Dockerfile

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,21 @@ FROM node:20-alpine
22

33
WORKDIR /librarium
44

5-
COPY ./scripts/entry.sh /entry.sh
5+
ENV DISABLE_PACKS_INTEGRATIONS=true
6+
ENV DISABLE_SECURITY_INTEGRATIONS=true
7+
68
COPY --chown=node . .
7-
RUN apk add util-linux && \
8-
chmod +x /entry.sh && \
9-
mkdir .cache && \
10-
npm ci && \
11-
chown -R node:node /librarium
9+
10+
RUN apk add --no-cache util-linux bash && \
11+
npm install @docusaurus/faster &&\
12+
npm ci && \
13+
chmod -R +x scripts
14+
15+
16+
RUN chown -R node:node /librarium
17+
1218

1319
EXPOSE 9000
1420
USER node
15-
ENTRYPOINT ["/entry.sh"]
16-
CMD ["npm", "run", "start"]
21+
22+
CMD ["npm","run","start"]

Makefile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,11 @@ init: ## Initialize npm dependencies
8585
grep -q "^ALGOLIA_APP_ID=" .env || echo "\nALGOLIA_APP_ID=1234567890" >> .env
8686
grep -q "^ALGOLIA_SEARCH_KEY=" .env || echo "\nALGOLIA_SEARCH_KEY=1234567890" >> .env
8787
grep -q "^ALGOLIA_INDEX_NAME=" .env || echo "\nALGOLIA_INDEX_NAME=spectrocloud" >> .env
88+
grep -q "^DSO_AUTH_TOKEN=" .env || echo "\nDISABLE_SECURITY_INTEGRATIONS=true\nDSO_AUTH_TOKEN=" >> .env
89+
grep -q "^PALETTE_API_KEY=" .env || echo "\nDISABLE_PACKS_INTEGRATIONS=true" >> .env
8890
npx husky install
8991

9092
start: ## Start a local development server
91-
make generate-partials
92-
npm run cves
9393
npm run start
9494

9595
start-cached-packs: ## Start a local development server with cached packs retry.
@@ -183,8 +183,8 @@ commit: ## Add a Git commit. Usage: make commit MESSAGE="<your message here>"
183183
docker-image: ## Build the docker image
184184
docker build -t $(IMAGE) .
185185

186-
docker-start: docker-image ## Start a local development container
187-
docker run --env-file=.env --rm -it -v $(CURDIR)/docs:/librarium/docs/ -p 9000:9000 $(IMAGE)
186+
docker-start: docker-image ## Build the docker image and start a local development container
187+
docker run --env-file=.env --rm -it -v $(CURDIR)/docs:/librarium/docs/ -v $(CURDIR)/_partials/:/librarium/_partials/ -p 9000:9000 $(IMAGE)
188188

189189

190190
##@ Writing Checks
@@ -296,4 +296,4 @@ update-dev-index: ## Update the Algolia index for the dev environment
296296

297297
remove-dev-index: ## Remove the Algolia index for the dev environment
298298
@echo "removing Algolia index for dev environment"
299-
algolia index delete dev-docusaurus-librarium --confirm
299+
algolia index delete dev-docusaurus-librarium --confirm

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,13 @@ Initialize the repository by issuing the following command:
3838
make init
3939
```
4040

41-
Next, add your Palette API key to the `.env` file. Replace `<your-palette-api-key>` with your Palette API key.
41+
By default, the [Packs component](#packs-component) is disabled. If you would like to enable it, then add your Palette
42+
API key and set `DISABLE_PACKS_INTEGRATIONS` to `false` in the `.env` file. Replace `<your-palette-api-key>` with your
43+
Palette API key.
4244

4345
```shell
4446
PALETTE_API_KEY="<your-palette-api-key>"
47+
DISABLE_PACKS_INTEGRATIONS=false
4548
```
4649

4750
> [!IMPORTANT] You need a Palette API key to start the local development server. Refer to the

docs/api-content/api-docs/2-samples.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,30 @@ want to deploy the cluster, such as public cloud or on-prem.
6969

7070
**Endpoint**: `https://api.spectrocloud.com/v1/spectroclusters/{provider}`
7171

72-
Set the provider as an environment variable.
72+
The following table outlines all available provider options.
73+
74+
| **Provider** | **Value** |
75+
| ---------------------------------------------- | ------------- |
76+
| **Azure IaaS** | `azure` |
77+
| **Azure AKS** | `aks` |
78+
| **AWS IaaS** | `aws` |
79+
| **AWS EKS** | `eks` |
80+
| **GCP IaaS** | `gcp` |
81+
| **GCP GKE** | `gke` |
82+
| **TKE** (Tencent) | `tke` |
83+
| **MAAS** (Canonical) | `maas` |
84+
| **VMware vSphere** | `vsphere` |
85+
| **Openstack** | `openstack` |
86+
| **Edge Native** | `edge-native` |
87+
| [**Virtual**](/devx/palette-virtual-clusters/) | `virtual` |
88+
89+
Set the provider as an environment variable. For example, issue the following command to set Azure IaaS as the provider.
7390

7491
```shell
75-
export PROVIDER="Your Provider"
92+
export PROVIDER="azure"
7693
```
7794

78-
<br />
95+
Example payload.
7996

8097
```shell
8198
export PAYLOAD='{
@@ -93,10 +110,10 @@ export PAYLOAD='{
93110
<TabItem label="curl" value="cluster-create-curl">
94111

95112
```shell
96-
curl --location 'https://api.spectrocloud.com/v1/spectroclusters/$PROVIDER?projectUid=$PROJECT_ID"' \
113+
curl --location "https://api.spectrocloud.com/v1/spectroclusters/$PROVIDER?projectUid=$PROJECT_ID" \
97114
--header 'Content-Type: application/json' \
98115
--header 'Accept: application/json' \
99-
--header "apiKey: $API_KEY"
116+
--header "apiKey: $API_KEY" \
100117
--data "$PAYLOAD"
101118
```
102119

@@ -1647,10 +1664,10 @@ export CLUSTER_ID="Your Cluster ID"
16471664
<TabItem label="cURL" value="cluster-kubeconfig-curl">
16481665

16491666
```shell
1650-
curl --location 'https://api.spectrocloud.com/v1/spectroclusters/$CLUSTER_ID/assets/kubeconfig' \
1667+
curl --location "https://api.spectrocloud.com/v1/spectroclusters/$CLUSTER_ID/assets/kubeconfig" \
16511668
--header 'Accept: application/octet-stream' \
1652-
--header 'projectUid: $PROJECT_ID' \
1653-
--header 'apiKey: $API_KEY'
1669+
--header "projectUid: $PROJECT_ID" \
1670+
--header "apiKey: $API_KEY"
16541671
```
16551672

16561673
</TabItem>

docs/docs-content/profiles/cluster-profiles/create-cluster-profiles/define-profile-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The following table describes the difference between profile variables and macro
3333
| Belongs to the tenant scope |||
3434
| Supports data format restrictions |||
3535
| Supports optionality restrictions |||
36-
| Supports [sprig template functions](https://masterminds.github.io/sprig/) | ||
36+
| Supports [sprig template functions](https://masterminds.github.io/sprig/) | ||
3737

3838
This guide explains how you can define and manage cluster profile variables.
3939

docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
409409
410410
You may encounter an error message during the OVA deployment stating unable to retrieve manifest or certificate.
411411
This is a known issue that was fixed in the
412-
[VMware vCenter Server 7.0 Update 3q](https://docs.vmware.com/en/VMware-vSphere/7.0/rn/vsphere-vcenter-server-70u3q-release-notes/index.html).
412+
[VMware vCenter Server 7.0 Update 3q](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/7-0/release-notes/vcenter-server-update-and-patch-releases/vsphere-vcenter-server-70u3q-release-notes.html).
413413
Reach out to [Broadcom Support](https://support.broadcom.com) if you need further guidance.
414414
415415
:::

docs/docs-content/vm-management/vm-migration-assistant/create-migration-plans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Follow this guide to create migration plans using the VM Migration Assistant.
7878
- The <VersionedLink text="Virtual Machine Migration Assistant" url="/integrations/packs/?pack=vm-migration-assistant-pack"/> pack must be added to your cluster profile. Refer to [Create a VM Migration Assistant Cluster Profile](./create-vm-migration-assistant-profile.md) for guidance.
7979
- The VM Migration Assistant service console must be accessible from a web browser.
8080

81-
- We recommend using a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) to uninstall [VMware Tools](https://docs.vmware.com/en/VMware-Tools/index.html), and install the [QEMU Guest Agent](https://wiki.qemu.org/Features/GuestAgent) and [VirtiIO drivers](https://github.com/virtio-win/kvm-guest-drivers-windows) on your migrated VMs. Installing the QEMU agent and Virtio drivers enhances compatibility with [KVM](https://linux-kvm.org/page/Main_Page), and enables advanced features like live migration and accurate reporting of guest status.
81+
- We recommend using a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) to uninstall [VMware Tools](https://docs.vmware.com/en/VMware-Tools/index.html), and install the [QEMU Guest Agent](https://wiki.qemu.org/Features/GuestAgent) and [VirtiIO drivers](https://github.com/virtio-win/kvm-guest-drivers-windows) on your migrated VMs. Installing the QEMU agent and Virtio drivers enhances compatibility with VMO, and enables advanced features like live migration and accurate reporting of guest status.
8282

8383
You can provide [virt-customize](https://github.com/kubev2v/forklift/commit/650d73d2308d73fe596666a2f097aefda32845f6) scripts inside a ConfigMap to automatically perform these actions on your VMs during migration. The ConfigMap must exist in your target namespace before migrating your VMs.
8484

docs/docs-content/vm-management/vm-migration-assistant/create-source-providers.md

Lines changed: 4 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -27,57 +27,16 @@ Machines (VMs) that need to be migrated.
2727

2828
- The VMO cluster must have network connectivity to vCenter and ESXi hosts, and the VMs you want to migrate.
2929

30-
:::warning
31-
32-
If you need to provision `Block` storage volumes during the VM migration process, add the following custom
33-
configuration to your VMO cluster OS pack. Applying this configuration may cause a cluster repave. For more
34-
information, refer to
35-
[Repave Behaviors and Configurations](../../clusters/cluster-management/node-pool.md#repave-behavior-and-configuration)
36-
37-
Additionally, we recommend provisioning volumes with the `ReadWriteMany` access mode to ensure that VMs can be
38-
[live migrated](https://kubevirt.io/user-guide/compute/live_migration/#limitations).
39-
40-
```yaml
41-
kubeadmconfig:
42-
preKubeadmCommands:
43-
# Start containerd with new configuration
44-
- systemctl daemon-reload
45-
- systemctl restart containerd
46-
files:
47-
- targetPath: /etc/containerd/config.toml
48-
targetOwner: "root:root"
49-
targetPermissions: "0644"
50-
content: |
51-
## template: jinja
52-
53-
# Use config version 2 to enable new configuration fields.
54-
version = 2
55-
56-
imports = ["/etc/containerd/conf.d/*.toml"]
57-
58-
[plugins]
59-
[plugins."io.containerd.grpc.v1.cri"]
60-
sandbox_image = "registry.k8s.io/pause:3.9"
61-
device_ownership_from_security_context = true
62-
[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc]
63-
runtime_type = "io.containerd.runc.v2"
64-
[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
65-
SystemdCgroup = true
66-
```
67-
68-
:::
69-
7030
- A vCenter user account with the following necessary privileges to perform migrations.
7131

7232
| **Privileges** | **Description** |
7333
|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
74-
| **[Virtual machine.Interaction.Power Off](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.security.doc/GUID-3D47149A-947D-4608-88B3-E5811129EFA8.html)** | Allows shutting down a powered-on virtual machine, powering down its guest operating system. |
75-
| **[Virtual machine.Interaction.Power On](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.security.doc/GUID-3D47149A-947D-4608-88B3-E5811129EFA8.html)** | Enables starting a powered-off virtual machine or resuming a suspended one. |
76-
| [**Virtual Machine Interaction Privileges** (all)](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.security.doc/GUID-3D47149A-947D-4608-88B3-E5811129EFA8.html) | Allow creating, cloning, modifying, customizing, and managing templates, virtual machines, their files, and customization specifications, as well as performing disk and deployment-related operations. |
77-
| **[Virtual machine.Snapshot management.Create snapshot](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.security.doc/GUID-222FE721-0968-4E9E-9F98-7CB03E7185E8.html)** | Allows capturing the current state of a virtual machine as a snapshot. |
78-
| **[Virtual machine.Snapshot management.Remove Snapshot](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.security.doc/GUID-222FE721-0968-4E9E-9F98-7CB03E7185E8.html)** | Permits deletion of a snapshot from the snapshot history. |
34+
| [**Virtual Machine Interaction Privileges** (all)](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/8-0/vsphere-security-8-0/defined-privileges/virtual-machine-interaction-privileges.html) | Allow creating, cloning, modifying, customizing, and managing templates, virtual machines, their files, and customization specifications, as well as performing disk and deployment-related operations. |
35+
| **[Virtual machine.Snapshot management.Create snapshot](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/8-0/vsphere-security-8-0/defined-privileges/virtual-machine-snapshot-management-privileges.html)** | Allows capturing the current state of a virtual machine as a snapshot. |
36+
| **[Virtual machine.Snapshot management.Remove Snapshot](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/8-0/vsphere-security-8-0/defined-privileges/virtual-machine-snapshot-management-privileges.html)** | Permits deletion of a snapshot from the snapshot history. |
7937

8038
- Migrations can be optionally accelerated by providing credentials for the ESXi hosts where the VMs reside.
39+
8140
- One or more VMs hosted in VMware vSphere. Only VMs whose operating systems are included under
8241
[`virt-v2v` supported guest systems](https://libguestfs.org/virt-v2v-support.1.html) can be migrated.
8342

0 commit comments

Comments
 (0)