Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update download URLs #2481

Merged
merged 2 commits into from
Mar 26, 2024
Merged

Update download URLs #2481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c7bdab
docs: Update download URLs
yuliiiah Mar 26, 2024
79c34ce
docs: Edit a missed version reference
yuliiiah Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/docs-content/component.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,18 @@ This page lists the version details of various Palette components and their resp

| Palette Release | Recommended CLI Version |
| --------------- | ----------------------- |
| Release 4.2.2 | 4.2.0 |
| Release 4.1.0 | 4.1.0 |
| Release 4.0.0 | 4.0.0 |
| Release 3.4.0 | 3.4.0 |
| Release 3.3.0 | 3.3.0 |
| Release 4.3.0 | v4.3.4 |
| Release 4.2.2 | v4.2.0 |
| Release 4.1.0 | v4.1.0 |
| Release 4.0.0 | v4.0.0 |
| Release 3.4.0 | v3.4.0 |
| Release 3.3.0 | v3.3.0 |

## Palette Edge CLI Versions

| Palette Release | CLI Version |
| --------------- | ----------- |
| Release 4.3.0 | v4.3.2 |
| Release 4.2.3 | v4.2.0 |
| Release 4.1.0 | v4.1.2 |
| Release 4.0.0 | v4.0.0 |
Expand Down
10 changes: 1 addition & 9 deletions docs/docs-content/palette-cli/install-palette-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,20 +41,14 @@ The Palette CLI is available for the following operating systems and architectur
4. Move the binary to a folder that is part of your system's `PATH` environment variable. Use the following command to
move the binary to the **/usr/local/bin** folder.

<br />

```shell
sudo mv ~/Downloads/palette /usr/local/bin/palette && \
chmod +x /usr/local/bin/palette
```

<br />

5. Log in to Palette by using the `login` command. Replace `<YOUR-API-KEY>` with your Palette API key. If you are using
a Palette self-hosted instance or Palette VerteX, replace the `--console-url` with your custom Palette URL.

<br />

```shell
palette login --api-key <YOUR-API-KEY> --console-url https://console.spectrocloud.com/
```
Expand All @@ -63,14 +57,12 @@ The Palette CLI is available for the following operating systems and architectur

Verify the Palette CLI is part of your system path by issuing the Palette CLI `version` command.

<br />

```shell
palette version
```

```shell hideClipboard
Palette CLI version: 4.2.2
Palette CLI version: 4.3.4
```

## Next Steps
Expand Down
32 changes: 2 additions & 30 deletions docs/docs-content/registries-and-packs/advanced-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ configuration options through the usage of environment variables.

The configuration file is divided into keys and values. The following is an example of a YAML configuration.

<br />

```yaml
version: 0.1
log:
Expand All @@ -26,20 +24,14 @@ The key `version` has a number value. The `log` key has a value with multiple ke

To override the value of `log.level` you can specify an environment variable named `REGISTRY_LOG_LEVEL`.

<br />

```shell
export REGISTRY_LOG_LEVEL=debug
```

<br />

## Default Configuration

The docker image for the registry contains the following default configuration values.

<br />

```yaml
version: 0.1
log:
Expand Down Expand Up @@ -72,8 +64,6 @@ For example, you can start the docker container image with the following environ
the basic auth realm and logging level. In the following example, the `-e` flag is used to provide environment variables
to the container.

<br />

```bash
docker run -d \
--rm \
Expand All @@ -83,21 +73,19 @@ docker run -d \
-e REGISTRY_LOG_LEVEL=debug \
-e REGISTRY_AUTH=htpasswd \
-e REGISTRY_AUTH_HTPASSWD_REALM="My Enterprise Realm" \
gcr.io/spectro-images-public/release/spectro-registry:3.4.0
gcr.io/spectro-images-public/release/spectro-registry:4.0.2
```

Alternatively, you can start the container by mounting a directory with a new configuration file and pointing the server
command to the configuration file.

<br />

```shell
docker run -d \
--rm \
-p 443:5000 \
--name spectro-registry \
--volume $(pwd)/myconfig.yml:/etc/myconfig.yml \
gcr.io/spectro-images-public/release/spectro-registry:3.4.0 \
gcr.io/spectro-images-public/release/spectro-registry:4.0.2 \
serve /etc/spectropaxconfig/myconfig.yml
```

Expand All @@ -118,8 +106,6 @@ storage:

If you are using S3 Storage, ensure you specify the required S3 parameters.

<br />

```yaml
storage:
cache:
Expand All @@ -139,8 +125,6 @@ storage:
You can also use ephemeral storage. We recommend using ephemeral storage for testing purposes. Production environments
should use object storage or a file system.

<br />

```yaml
storage: inmemory
```
Expand All @@ -150,8 +134,6 @@ storage: inmemory
You can configure basic HTTP Auth. Basic Auth requires providing the pack registry server with an httppasswd file
containing the credentials.

<br />

```yaml
auth:
htpasswd:
Expand All @@ -167,17 +149,13 @@ The following options are available for modifying HTTP transport:

For serving content on all interfaces on port 5000:

<br />

```yaml
http:
addr: :5000
```

Alternatively, the server can bind to a single IP and different port:

<br />

```yaml
http:
addr: 192.168.122.77:25000
Expand All @@ -187,8 +165,6 @@ http:

The following headers are the default, and can be overridden:

<br />

```yaml
http:
headers:
Expand All @@ -209,8 +185,6 @@ validation by the Let's Encrypt services. Check out the
[Deploy Pack Registry Server with Let's Encrypt](adding-a-custom-registry.md#deploy-pack-registry-server-with-lets-encrypt)
guide to learn more.

<br />

```yaml
http:
addr: :5000
Expand All @@ -227,8 +201,6 @@ volume where the certificates are permanently stored. Use the option `cachefile`

You can specify custom certificates by providing the file path to the certificate files.

<br />

```yaml
http:
tls:
Expand Down
18 changes: 3 additions & 15 deletions docs/docs-content/registries-and-packs/spectro-cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ The Spectro CLI tool is currently available for OSX and Linux.
<TabItem label="OSX" value="osx_cli">

```bash
wget https://spectro-cli.s3.amazonaws.com/v4.2.0/osx/spectro
wget https://spectro-cli.s3.amazonaws.com/v4.3.0/osx/spectro
```

</TabItem>

<TabItem label="Linux" value="linux_cli">

```bash
wget https://spectro-cli.s3.amazonaws.com/v4.2.0/linux/spectro
wget https://spectro-cli.s3.amazonaws.com/v4.3.0/linux/spectro
```

</TabItem>
Expand Down Expand Up @@ -87,8 +87,6 @@ Authenticate user with Spectro Cloud pack registry by using the login command:
spectro registry login spectro.io:5000 --insecure --default
```

<br />

#### Arguments

SERVER - Spectro Cloud pack registry server in the format [host:port]
Expand All @@ -106,8 +104,6 @@ If you have access to the pack registry's Certificate Authority (CA) certificate

:::

<br />

## Pack

The following subcommands are available for the `pack` command.
Expand Down Expand Up @@ -136,8 +132,6 @@ PACK_NAME - Name of the pack TARGET_DIR - Directory containing the pack data

-r, --registry-server - Override the default Spectro registry

<br />

### Push

Upload the pack content from the pack source dir to the Spectro Cloud pack registry.
Expand Down Expand Up @@ -177,8 +171,6 @@ enabled.
--skip-digest-check - By default, the _force_ option can push the pack only if the pack content digest is different than
the registry pack digest. So the _skip digest_ command can be used to skip the comparison of the digests.

<br />

### List

List all the packs from the Spectro Cloud pack registry:
Expand All @@ -197,8 +189,6 @@ List all the packs from the Spectro Cloud pack registry:
spectro pack ls spectro.io:5000 --name ubuntu --registry-server spectro.io:5000
```

<br />

#### Flags

-n, --name string - packs can be filtered by pack name
Expand Down Expand Up @@ -275,8 +265,6 @@ TARGET_LABEL - Target tag label.

-r, --registry-server string - To override the default Spectro Cloud pack registry.

<br />

To remove a tag from a pack which is already pushed to the pack registry use the `pack tag delete` subcommand.

```bash
Expand Down Expand Up @@ -319,5 +307,5 @@ spectro version
```

```bash hideClipboard
Spectro ClI Version 4.2.0 linux/amd64
Spectro CLI Version 4.3.4 linux/amd64
```
4 changes: 2 additions & 2 deletions docs/docs-content/spectro-downloads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ the [Palette CLI](/palette-cli/install-palette-cli) document for installation gu

| Version | Operating System | Checksum (SHA256) |
| ------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| 4.2.4 | [Linux-amd64](https://software.spectrocloud.com/palette-cli/v4.2.4/linux/cli/palette) | `3e1cddc25c7c883e6385b9c8365519cef66d1893756e5794947de2cf38d02092` |
| 4.3.4 | [Linux-amd64](https://software.spectrocloud.com/palette-cli/v4.3.4/linux/cli/palette) | `853bfc7340a87e779010a700407c9f1e40728a07578edd5347fa68562284db33` |

## Palette Edge CLI

| Version | Operating System | Checksum (SHA256) |
| ------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| 4.2.3 | [Linux-amd64](https://software.spectrocloud.com/stylus/v4.2.3/cli/linux/palette-edge) | `5f781b6e1332972130f53783684a16c34a1d6bb57f5fcadc818f562690c6a044` |
| 4.3.2 | [Linux-amd64](https://software.spectrocloud.com/stylus/v4.3.2/cli/linux/palette-edge) | `c424a9e72019e1e62f7ac8268e565984702e5783beba93f06ba698b0a37b521a` |
Loading