Skip to content

Release notes for SDK 1.0.0-beta.31 plus related docs #2750

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

Merged
merged 3 commits into from
Oct 17, 2024
Merged

Release notes for SDK 1.0.0-beta.31 plus related docs #2750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f0b4be
Release notes for SDK 1.0.0-beta.31 plus related docs
divolgin Oct 17, 2024
e239cce
bump sdk version in yaml samples
paigecalvert Oct 17, 2024
0d7aee9
edits to clusterrole steps
paigecalvert Oct 17, 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
2 changes: 1 addition & 1 deletion docs/partials/replicated-sdk/_dependency-yaml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
dependencies:
- name: replicated
repository: oci://registry.replicated.com/library
version: 1.0.0-beta.29
version: 1.0.0-beta.31
```

For the latest version information for the Replicated SDK, see the [replicated-sdk repository](https://github.com/replicatedhq/replicated-sdk/tags) in GitHub.
7 changes: 7 additions & 0 deletions docs/release-notes/rn-replicated-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ pagination_prev: null

This topic contains release notes for the [Replicated SDK](/vendor/replicated-sdk-overview). The release notes list new features, improvements, bug fixes, known issues, and breaking changes.

## 1.0.0-beta.31

Released on October 17, 2024

### New Features {#new-features-1-0-0-beta-31}
* Adds support for specifying ClusterRole using the [clusterRole](/vendor/replicated-sdk-customizing#custom-clusterrole) key.

## 1.0.0-beta.30

Released on October 16, 2024
Expand Down
19 changes: 19 additions & 0 deletions docs/vendor/replicated-sdk-customizing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ The SDK requires the following minimum RBAC permissions:
The Replicated Vendor Portal uses status informers to provide application status data. For more information, see [Helm Installations](/vendor/insights-app-status#helm-installations) in _Enabling and Understanding Application Status_.
### Install the SDK with Custom RBAC

#### Custom ServiceAccount

To use the SDK with custom RBAC permissions, provide the name for a custom ServiceAccount object during installation. When a service account is provided, the SDK uses the RBAC permissions granted to the service account and does not create the default Role, RoleBinding, or ServiceAccount objects.

To install the SDK with custom RBAC:
Expand All @@ -80,6 +82,23 @@ To install the SDK with custom RBAC:

For more information about installing with Helm, see [Installing with Helm](/vendor/install-with-helm).

#### Custom ClusterRole

To use the SDK with an existing ClusterRole, provide the name for a custom ClusterRole object during installation. When a cluster role is provided, the SDK uses the RBAC permissions granted to the cluster role and does not create the default RoleBinding. Instead, the SDK creates a ClusterRoleBinding as well as a ServiceAccount object.

To install the SDK with a custom ClusterRole:

1. Create a custom ClusterRole object. The ClusterRole must meet at least the minimum requirements described in [Minimum RBAC Requirements](#minimum-rbac-requirements) above. However, it can also provide additional permissions that can be used by the SDK, such as listing cluster Nodes.
1. During installation, provide the name of the cluster role that you created by including `--set replicated.clusterRole=CUSTOM_CLUSTERROLE_NAME`.

**Example**:

```
helm install wordpress oci://registry.replicated.com/my-app/beta/wordpress --set replicated.clusterRole=mycustomclusterrole
```

For more information about installing with Helm, see [Installing with Helm](/vendor/install-with-helm).

## Set Environment Variables {#env-var}

The Replicated SDK provides a `replicated.extraEnv` value that allows users to set additional environment variables for the deployment that are not exposed as Helm values.
Expand Down
4 changes: 2 additions & 2 deletions docs/vendor/replicated-sdk-installing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ To add the SDK Helm chart to a release for a standard manifest-based application
```
Where `SDK_VERSION` is the version of the SDK to install. For a list of available SDK versions, see the [replicated-sdk repository](https://github.com/replicatedhq/replicated-sdk/tags) in GitHub.

The output of this command is a `.tgz` file with the naming convention `CHART_NAME-CHART_VERSION.tgz`. For example, `replicated-1.0.0-beta.13.tgz`.
The output of this command is a `.tgz` file with the naming convention `CHART_NAME-CHART_VERSION.tgz`. For example, `replicated-1.0.0-beta.31.tgz`.

For more information and additional options, see [Helm Pull](https://helm.sh/docs/helm/helm_pull/) in the Helm documentation.

Expand Down Expand Up @@ -111,7 +111,7 @@ To add the SDK Helm chart to a release for a standard manifest-based application
name: replicated
# for chartversion, enter the version of the
# SDK Helm chart in the release
chartVersion: 1.0.0-beta.13
chartVersion: 1.0.0-beta.31
```

As shown in the example above, the HelmChart custom resource requires the name and version of the SDK Helm chart that you added to the release:
Expand Down