Skip to content

Update from nginxinc to nginx #437

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.

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 2 commits into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ that issue here in this description (not in the title of the PR).

Before creating a PR, run through this checklist and mark each as complete.

- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/nginx-plus-go-client/blob/main/CONTRIBUTING.md) doc
- [ ] I have read the [CONTRIBUTING](https://github.com/nginx/nginx-plus-go-client/blob/main/CONTRIBUTING.md) doc
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have checked that all unit tests pass after adding my changes
- [ ] I have updated necessary documentation
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/dependency-review.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ jobs:
- name: Dependency Review
uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4.5.0
with:
config-file: "nginxinc/k8s-common/dependency-review-config.yml@main"
config-file: "nginx/k8s-common/dependency-review-config.yml@main"
2 changes: 1 addition & 1 deletion .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
sparse-checkout: |
labeler.yml
sparse-checkout-cone-mode: false
repository: nginxinc/k8s-common
repository: nginx/k8s-common

- uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0
with:
Expand Down
36 changes: 18 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Changelog

Starting with version 0.8.0, an automatically generated list of changes can be found on the [GitHub Releases page](https://github.com/nginxinc/nginx-plus-go-client/releases).
Starting with version 0.8.0, an automatically generated list of changes can be found on the [GitHub Releases page](https://github.com/nginx/nginx-plus-go-client/releases).

## 0.7.0 (Jul 10, 2020)

FEATURES:

- [38](https://github.com/nginxinc/nginx-plus-go-client/pull/38): *Support for /slabs API endpoint*. The client now
- [38](https://github.com/nginx/nginx-plus-go-client/pull/38): _Support for /slabs API endpoint_. The client now
supports retrieving shared memory zone usage info.
- [41](https://github.com/nginxinc/nginx-plus-go-client/pull/41): *Support for /processes API endpoint*. The client now
- [41](https://github.com/nginx/nginx-plus-go-client/pull/41): _Support for /processes API endpoint_. The client now
supports retrieving processes info.

CHANGES:
Expand All @@ -20,7 +20,7 @@ CHANGES:

FEATURES:

- [34](https://github.com/nginxinc/nginx-plus-go-client/pull/34): *Support for updating upstream servers parameters*.
- [34](https://github.com/nginx/nginx-plus-go-client/pull/34): _Support for updating upstream servers parameters_.
The client now supports updating upstream parameters of servers that already exist in NGINX Plus.

CHANGES:
Expand All @@ -35,14 +35,14 @@ CHANGES:

FEATURES:

- [30](https://github.com/nginxinc/nginx-plus-go-client/pull/30): *Support additional upstream server parameters*. The
client now supports configuring `route`, `backup`, `down`, `drain`, `weight` and `service` parameters for http
upstreams and `backup`, `down`, `weight` and `service` parameters for stream upstreams.
- [31](https://github.com/nginxinc/nginx-plus-go-client/pull/31): *Support location zones and resolver metrics*.
- [30](https://github.com/nginx/nginx-plus-go-client/pull/30): _Support additional upstream server parameters_. The
client now supports configuring `route`, `backup`, `down`, `drain`, `weight` and `service` parameters for http
upstreams and `backup`, `down`, `weight` and `service` parameters for stream upstreams.
- [31](https://github.com/nginx/nginx-plus-go-client/pull/31): _Support location zones and resolver metrics_.

FIXES:

- [29](https://github.com/nginxinc/nginx-plus-go-client/pull/29): *Fix max_fails parameter in upstream servers*.
- [29](https://github.com/nginx/nginx-plus-go-client/pull/29): _Fix max_fails parameter in upstream servers_.
Previously, if the MaxFails field was not explicitly set, the client would incorrectly configure an upstream with the
value `0` instead of the correct value `1`.

Expand All @@ -55,45 +55,45 @@ CHANGES:

FEATURES:

- [24](https://github.com/nginxinc/nginx-plus-go-client/pull/24): *Support `MaxConns` in upstream servers*.
- [24](https://github.com/nginx/nginx-plus-go-client/pull/24): _Support `MaxConns` in upstream servers_.

FIXES:

- [25](https://github.com/nginxinc/nginx-plus-go-client/pull/25): *Fix session metrics for stream server zones*. Session
- [25](https://github.com/nginx/nginx-plus-go-client/pull/25): _Fix session metrics for stream server zones_. Session
metrics with a status of `4xx` or `5xx` are now correctly reported. Previously they were always reported as `0`.

## 0.3.1 (June 10, 2019)

CHANGES:

- [22](https://github.com/nginxinc/nginx-plus-go-client/pull/22): *Change in stream zone sync metrics*. `StreamZoneSync`
- [22](https://github.com/nginx/nginx-plus-go-client/pull/22): _Change in stream zone sync metrics_. `StreamZoneSync`
field of the `Stats` type is now a pointer. It will be nil if NGINX Plus doesn't report any zone sync stats.

## 0.3 (May 29, 2019)

FEATURES:

- [20](https://github.com/nginxinc/nginx-plus-go-client/pull/20): *Support for stream zone sync metrics*. The client
- [20](https://github.com/nginx/nginx-plus-go-client/pull/20): _Support for stream zone sync metrics_. The client
`GetStats` method now additionally returns stream zone sync metrics.
- [13](https://github.com/nginxinc/nginx-plus-go-client/pull/13): *Support for key-value endpoints*. The client
- [13](https://github.com/nginx/nginx-plus-go-client/pull/13): _Support for key-value endpoints_. The client
implements a set of methods to create/modify/delete key-val pairs for both http and stream contexts.
- [12](https://github.com/nginxinc/nginx-plus-go-client/pull/12) *Support for NGINX status info*. The client `GetStats`
- [12](https://github.com/nginx/nginx-plus-go-client/pull/12) _Support for NGINX status info_. The client `GetStats`
method now additionally returns NGINX status metrics. Thanks to [jthurman42](https://github.com/jthurman42).

CHANGES:

- The repository was renamed to `nginx-plus-go-client` instead of `nginx-plus-go-sdk`. If the client is used as a
dependency, this name needs to be changed in the import section (`import
"github.com/nginxinc/nginx-plus-go-client/client"`).
"github.com/nginxinc/nginx-plus-go-client/client"`).
- The version of the API was changed to 4.
- The version of NGINX Plus for e2e testing was changed to R18.

## 0.2 (Sep 7, 2018)

FEATURES:

- [7](https://github.com/nginxinc/nginx-plus-go-sdk/pull/7): *Support for stream server zone and stream upstream
metrics*. The client `GetStats` method now additionally returns stream server zone and stream upstream metrics.
- [7](https://github.com/nginx/nginx-plus-go-client/pull/7): _Support for stream server zone and stream upstream
metrics_. The client `GetStats` method now additionally returns stream server zone and stream upstream metrics.

CHANGES:

Expand Down
2 changes: 1 addition & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @nginxinc/integrations
* @nginx/integrations
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ considering contributing!

## Ask a Question

To ask a question please use [Github Discussions](https://github.com/nginxinc/nginx-plus-go-client/discussions).
To ask a question please use [Github Discussions](https://github.com/nginx/nginx-plus-go-client/discussions).

You can also join our [Community Slack](https://community.nginx.org/joinslack) which has a wider NGINX audience.

Expand Down Expand Up @@ -90,6 +90,6 @@ can be merged. Your agreement signature will be safely stored by F5 and no longe
- Run `gofmt` over your code to automatically resolve a lot of style issues. Most editors support this running
automatically when saving a code file.
- Run `go lint` and `go vet` on your code too to catch any other issues.
- Follow this guide on some good practice and idioms for Go - <https://github.com/golang/go/wiki/CodeReviewComments>
- Follow this guide on some good practice and idioms for Go - <https://github.com/golang/go/wiki/CodeReviewComments>
- To check for extra issues, install [golangci-lint](https://github.com/golangci/golangci-lint) and run `make lint` or
`golangci-lint run`
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!-- markdownlint-disable-next-line first-line-h1 -->
[![OpenSSFScorecard](https://api.securityscorecards.dev/projects/github.com/nginxinc/nginx-plus-go-client/badge)](https://scorecard.dev/viewer/?uri=github.com/nginxinc/nginx-plus-go-client)
[![Continuous Integration](https://github.com/nginxinc/nginx-plus-go-client/workflows/Continuous%20Integration/badge.svg)](https://github.com/nginxinc/nginx-plus-go-client/actions)
[![OpenSSFScorecard](https://api.securityscorecards.dev/projects/github.com/nginx/nginx-plus-go-client/badge)](https://scorecard.dev/viewer/?uri=github.com/nginx/nginx-plus-go-client)
[![Continuous Integration](https://github.com/nginx/nginx-plus-go-client/workflows/Continuous%20Integration/badge.svg)](https://github.com/nginx/nginx-plus-go-client/actions)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Go Report Card](https://goreportcard.com/badge/github.com/nginxinc/nginx-plus-go-client)](https://goreportcard.com/report/github.com/nginxinc/nginx-plus-go-client)
[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B5618%2Fgithub.com%2Fnginxinc%2Fnginx-plus-go-client.svg?type=shield)](https://app.fossa.com/projects/custom%2B5618%2Fgithub.com%2Fnginxinc%2Fnginx-plus-go-client?ref=badge_shield)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nginxinc/nginx-plus-go-client?logo=github&sort=semver)](https://github.com/nginxinc/nginx-plus-go-client/releases/latest)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/nginxinc/nginx-plus-go-client?logo=go)
[![Go Report Card](https://goreportcard.com/badge/github.com/nginx/nginx-plus-go-client)](https://goreportcard.com/report/github.com/nginx/nginx-plus-go-client)
[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B5618%2Fgithub.com%2Fnginx%2Fnginx-plus-go-client.svg?type=shield)](https://app.fossa.com/projects/custom%2B5618%2Fgithub.com%2Fnginx%2Fnginx-plus-go-client?ref=badge_shield)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nginx/nginx-plus-go-client?logo=github&sort=semver)](https://github.com/nginx/nginx-plus-go-client/releases/latest)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/nginx/nginx-plus-go-client?logo=go)
[![Slack](https://img.shields.io/badge/slack-nginxcommunity-green?logo=slack)](https://nginxcommunity.slack.com)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginxinc/nginx-plus-go-client/blob/main/SECURITY.md)
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginx/nginx-plus-go-client/blob/main/SECURITY.md)

# NGINX Plus Go Client

Expand Down Expand Up @@ -41,17 +41,17 @@ This Client works against versions 4 to 9 of the NGINX Plus API. The table below
the API was first introduced.

| API version | NGINX Plus version |
|-------------|--------------------|
| 4 | R18 |
| 5 | R19 |
| 6 | R20 |
| 7 | R25 |
| 8 | R27 |
| 9 | R30 |
| ----------- | ------------------ |
| 4 | R18 |
| 5 | R19 |
| 6 | R20 |
| 7 | R25 |
| 8 | R27 |
| 9 | R30 |

## Using the Client

1. Import `github.com/nginxinc/nginx-plus-go-client/client` into your go project.
1. Import `github.com/nginx/nginx-plus-go-client/client` into your go project.
2. Use your favorite vendor tool to add this to your `/vendor` directory in your project.

## Testing
Expand Down
4 changes: 2 additions & 2 deletions compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ services:
volumes:
- type: bind
source: ./
target: /go/src/github.com/nginxinc/nginx-plus-go-client
working_dir: /go/src/github.com/nginxinc/nginx-plus-go-client
target: /go/src/github.com/nginx/nginx-plus-go-client
working_dir: /go/src/github.com/nginx/nginx-plus-go-client
command: go test -v -shuffle=on -race tests/client_test.go
depends_on:
- nginx
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/nginxinc/nginx-plus-go-client/v2
module github.com/nginx/nginx-plus-go-client/v2

go 1.22.6

Expand Down
16 changes: 8 additions & 8 deletions release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,21 @@ The project follows [Semantic Versioning](https://semver.org/) for versioning.
## Release Planning and Development

The features that will go into the next release are reflected in the
corresponding [milestone](https://github.com/nginxinc/nginx-plus-go-client/milestones). Refer to
corresponding [milestone](https://github.com/nginx/nginx-plus-go-client/milestones). Refer to
the [Issue Lifecycle](/ISSUE_LIFECYCLE.md) document for information on issue creation and assignment to releases.

## Releasing a New Version

1. Create an issue to define and track release-related activities. Choose a title that follows the
format `Release X.Y.Z`.
2. Stop merging any new work into the main branch.
3. Check the release draft under the [GitHub releases](https://github.com/nginxinc/nginx-plus-go-client/releases) page
to ensure that everything is in order.
3. Check the release draft under the [GitHub releases](https://github.com/nginx/nginx-plus-go-client/releases) page
to ensure that everything is in order.
4. Create and push the release tag in the format `vX.Y.Z`:

```bash
git tag -a vX.Y.Z -m "Release vX.Y.Z"
git push origin vX.Y.Z
```
```bash
git tag -a vX.Y.Z -m "Release vX.Y.Z"
git push origin vX.Y.Z
```

As a result, the CI/CD pipeline will publish the release and announce it in the community Slack.
As a result, the CI/CD pipeline will publish the release and announce it in the community Slack.
2 changes: 1 addition & 1 deletion renovate.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"github>nginxinc/k8s-common",
"github>nginx/k8s-common",
"schedule:earlyMondays"
]
}
4 changes: 2 additions & 2 deletions tests/client_no_stream_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import (
"context"
"testing"

"github.com/nginxinc/nginx-plus-go-client/v2/client"
"github.com/nginxinc/nginx-plus-go-client/v2/tests/helpers"
"github.com/nginx/nginx-plus-go-client/v2/client"
"github.com/nginx/nginx-plus-go-client/v2/tests/helpers"
)

// TestStatsNoStream tests the peculiar behavior of getting Stream-related
Expand Down
4 changes: 2 additions & 2 deletions tests/client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import (
"testing"
"time"

"github.com/nginxinc/nginx-plus-go-client/v2/client"
"github.com/nginxinc/nginx-plus-go-client/v2/tests/helpers"
"github.com/nginx/nginx-plus-go-client/v2/client"
"github.com/nginx/nginx-plus-go-client/v2/tests/helpers"
)

const (
Expand Down
Loading