Skip to content

docs: add namespace docs #521

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 2 commits into from
Jun 7, 2024
Merged

docs: add namespace docs #521

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba6dc91
doc: add namespace docs
andrew-waters Jun 5, 2024
63eaa28
Update providers/flipt/README.md
andrew-waters Jun 5, 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
20 changes: 15 additions & 5 deletions providers/flipt/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,23 +58,33 @@ func main() {

## Configuration

The Flipt provider allows you to change the [namespace](https://docs.flipt.io/concepts#namespaces) that the evaluation is performed against. If not provided, it defaults to the `Default` namespace:

### Target Namespace

```go
provider := flipt.NewProvider(flipt.ForNamespace("your-namespace"))
```

### Protocol

The Flipt provider allows you to communicate with Flipt over either HTTP(S) or GRPC, depending on the address provided.

### HTTP(S)
#### HTTP(S)

```go
provider := flipt.NewProvider(flipt.WithAddress("https://localhost:443"))
```

#### Unix Socket
##### Unix Socket

```go
provider := flipt.NewProvider(flipt.WithAddress("unix:///path/to/socket"))
```

### GRPC
#### GRPC

#### HTTP/2
##### HTTP/2

```go
type Token string
Expand All @@ -90,7 +100,7 @@ provider := flipt.NewProvider(
)
```

#### Unix Socket
##### Unix Socket

```go
provider := flipt.NewProvider(
Expand Down
Loading