blob: 4ce482daef118a127e34ce0782be6cfbf74a9abf [file] [view]
<!---
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# Tasks `ops admin`
Administer OpenServerless users.
## Synopsis
In OpenServerless, users are namespaces.
You can create namespaces and choose which services to enable.
```text
Usage:
admin adduser <username> <email> <password> [--all] [--redis] [--mongodb] [--minio|--seaweedfs] [--postgres] [--milvus] [--storagequota=<quota>|auto]
admin deleteuser <username> [--confirm-namespace-delete]
admin listuser [<username>]
admin sso unbind <username>
admin compact [--ttl=<ttl>|10]
admin usage [--debug]
```
## Commands
```
admin adduser create a new user in OpenServerless with the username, email and password provided
admin deleteuser delete a user from the OpenServerless installation via the username provided
admin listuser list all the secrets of an user (default list all the users)
admin sso unbind remove SSO binding while preserving the OpenServerless namespace
admin compact create a one shot job which executes couchdb compact against all available dbs
admin usage calculates and displays PVC disk usage statistics for bound volumes. Shows Total, Size and Available storage per PVC
```
## Options
```
--all enable all services
--redis enable redis
--mongodb enable mongodb
--minio enable minio
--seaweedfs enable seaweedfs
--postgres enable postgres
--milvus enable milvus vector db
--storagequota=<quota>
--confirm-namespace-delete explicitly delete a namespace on an SSO-enabled cluster
--ttl=<seconds> modify the job ttl after finished (defaults to 10 seconds)
--debug enable debug logging
```