repository

Documentation

Index

• Constants
• func CreateBackportIssues(ctx context.Context, client *github.Client, origIssue *github.Issue, ...) (*github.Issue, error)
• func IsValidRepo(repo string) bool
• func NewGithub(ctx context.Context, token string) *github.Client
• func OrgFromRepo(repo string) (string, error)
• func RetrieveOriginalIssue(ctx context.Context, client *github.Client, repo string, issueID uint) (*github.Issue, error)
• type ChangeLog
  • func RetrieveChangeLogContents(ctx context.Context, client *github.Client, ...) ([]ChangeLog, error)
• type Issue
• type TokenSource
  • func (t *TokenSource) Token() (*oauth2.Token, error)

Constants

const K3sReleaseNoteTemplate = `` /* 2355-byte string literal not displayed */

const RKE2ReleaseNoteTemplate = `<!-- {{.milestone}} -->

This release ... <FILL ME OUT!>

**Important Note**

If your server (control-plane) nodes were not started with the ` + "`--token`" + ` CLI flag or config file key, a randomized token was generated during initial cluster startup. This key is used both for joining new nodes to the cluster, and for encrypting cluster bootstrap data within the datastore. Ensure that you retain a copy of this token, as is required when restoring from backup.

You may retrieve the token value from any server already joined to the cluster:
` + "```bash" + `
cat /var/lib/rancher/rke2/server/token
` + "```" + `

## Changes since {{.prevMilestone}}:
{{range .content}}
* {{.Title}} [(#{{.Number}})]({{.URL}}){{end}}

## Packaged Component Versions
| Component       | Version                                                                                           |
| --------------- | ------------------------------------------------------------------------------------------------- |
| Kubernetes      | [{{.k8sVersion}}](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-{{.majorMinor}}.md#{{.changeLogVersion}}) |
| Etcd            | [{{.EtcdVersion}}](https://github.com/k3s-io/etcd/releases/tag/{{.EtcdVersion}})                          |
| Containerd      | [{{.ContainerdVersion}}](https://github.com/k3s-io/containerd/releases/tag/{{.ContainerdVersion}})                      |
| Runc            | [{{.RuncVersion}}](https://github.com/opencontainers/runc/releases/tag/{{.RuncVersion}})                              |
| CNI Plugins     | [{{.CNIPluginsVersion}}](https://github.com/containernetworking/plugins/releases/tag/{{.CNIPluginsVersion}})                      |
| Metrics-server  | [{{.MetricsServerVersion}}](https://github.com/kubernetes-sigs/metrics-server/releases/tag/{{.MetricsServerVersion}})                   |
| CoreDNS         | [{{.CoreDNSVersion}}](https://github.com/coredns/coredns/releases/tag/{{.CoreDNSVersion}})                                  |
| Ingress-Nginx   | [{{.IngressNginxVersion}}](https://github.com/kubernetes/ingress-nginx/releases/tag/helm-chart-{{.IngressNginxVersion}})                                  |
| Helm-controller | [{{.HelmControllerVersion}}](https://github.com/k3s-io/helm-controller/releases/tag/{{.HelmControllerVersion}})                         |

### Available CNIs
| Component       | Version                                                                                                                                                                             | FIPS Compliant |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| Canal (Default) | [Flannel {{.FlannelVersionRKE2}}](https://github.com/k3s-io/flannel/releases/tag/{{.FlannelVersionRKE2}})<br/>[Calico {{.CalicoVersion}}](https://projectcalico.docs.tigera.io/archive/v3.22/release-notes/#{{ .CalicoVersionTrimmed }}) | Yes            |
| Calico          | [{{.CalicoVersion}}](https://projectcalico.docs.tigera.io/archive/v3.22/release-notes/#{{ .CalicoVersionTrimmed }})                                                                                                                      | No             |
| Cilium          | [{{.CiliumVersion}}](https://github.com/cilium/cilium/releases/tag/{{.CiliumVersion}})                                                                                                                      | No             |
| Multus          | [{{.MultusVersion}}](https://github.com/k8snetworkplumbingwg/multus-cni/releases/tag/{{.MultusVersion}})                                                                                                    | No             |

## Known Issues

- [#1447](https://github.com/rancher/rke2/issues/1447) - When restoring RKE2 from backup to a new node, you should ensure that all pods are stopped following the initial restore:

` + "```" + `bash
curl -sfL https://get.rke2.io | sudo INSTALL_RKE2_VERSION={{.milestone}}
rke2 server \
  --cluster-reset \
  --cluster-reset-restore-path=<PATH-TO-SNAPSHOT> --token <token used in the original cluster>
rke2-killall.sh
systemctl enable rke2-server
systemctl start rke2-server
` + "```" + `

## Helpful Links

As always, we welcome and appreciate feedback from our community of users. Please feel free to:
- [Open issues here](https://github.com/rancher/rke2/issues/new)
- [Join our Slack channel](https://slack.rancher.io/)
- [Check out our documentation](https://docs.rke2.io) for guidance on how to get started.
`

Functions

func CreateBackportIssues

func CreateBackportIssues(ctx context.Context, client *github.Client, origIssue *github.Issue, repo, branch string, i *Issue) (*github.Issue, error)

CreateBackportIssues

func IsValidRepo

func IsValidRepo(repo string) bool

IsValidRepo determines if the given repository is valid for this program to operate against.

func NewGithub

func NewGithub(ctx context.Context, token string) *github.Client

NewGithub creates a value of type github.Client pointer with the given context and Github token.

func OrgFromRepo

func OrgFromRepo(repo string) (string, error)

OrgFromRepo gets the Github organization that the given repository is in or returns an error if it is not found.

func RetrieveOriginalIssue

func RetrieveOriginalIssue(ctx context.Context, client *github.Client, repo string, issueID uint) (*github.Issue, error)

RetrieveOriginalIssue

Types

type ChangeLog

type ChangeLog struct {
	Title  string
	Number int
	URL    string
}

ChangeLog contains the found changes for the given release, to be used in to populate the template.

func RetrieveChangeLogContents

func RetrieveChangeLogContents(ctx context.Context, client *github.Client, repo, prevMilestone, milestone string) ([]ChangeLog, error)

RetrieveChangeLogContents gets the relevant changes for the given release, formats, and returns them.

type Issue

type Issue struct {
	ID    uint
	Title string
	Body  string
}

type TokenSource

type TokenSource struct {
	AccessToken string
}

TokenSource

func (*TokenSource) Token

func (t *TokenSource) Token() (*oauth2.Token, error)

Token