Skip to content

Commit c3973a6

Browse files
docs: add namespace docs (#521)
Signed-off-by: Andrew Waters <[email protected]>
1 parent b90eb4d commit c3973a6

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

providers/flipt/README.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -58,23 +58,33 @@ func main() {
5858

5959
## Configuration
6060

61+
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:
62+
63+
### Target Namespace
64+
65+
```go
66+
provider := flipt.NewProvider(flipt.ForNamespace("your-namespace"))
67+
```
68+
69+
### Protocol
70+
6171
The Flipt provider allows you to communicate with Flipt over either HTTP(S) or GRPC, depending on the address provided.
6272

63-
### HTTP(S)
73+
#### HTTP(S)
6474

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

69-
#### Unix Socket
79+
##### Unix Socket
7080

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

75-
### GRPC
85+
#### GRPC
7686

77-
#### HTTP/2
87+
##### HTTP/2
7888

7989
```go
8090
type Token string
@@ -90,7 +100,7 @@ provider := flipt.NewProvider(
90100
)
91101
```
92102

93-
#### Unix Socket
103+
##### Unix Socket
94104

95105
```go
96106
provider := flipt.NewProvider(

0 commit comments

Comments
 (0)