doc: document the project config options #12251
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gabrielmougard
force-pushed
the
feat/doc-project-config-options
branch
from
c9fecd5
to
a6a828e
Compare
|
@gabrielmougard can you rebase this so tests re-run now youve got the extension merged. |
gabrielmougard
force-pushed
the
feat/doc-project-config-options
branch
from
a6a828e
to
8854775
Compare
|
@gabrielmougard I just reviewed and pushed a commit with doc updates to your branch. Please check and squash as required. |
|
@gabrielmougard tests are failing |
gabrielmougard
force-pushed
the
feat/doc-project-config-options
branch
from
8ec2306
to
7eebf62
Compare
|
@ru-fu I integrated your commit |
ru-fu
suggested changes
Sep 26, 2023
doc/authentication.md
Outdated
| @@ -73,7 +73,7 @@ It's possible to restrict a TLS client to one or multiple projects. | |||
| In this case, the client will also be prevented from performing global configuration changes or altering the configuration (limits, restrictions) of the projects it's allowed access to. | |||
|
|
|||
| To restrict access, use [`lxc config trust edit <fingerprint>`](lxc_config_trust_edit.md). | |||
| Set the `restricted` key to `true` and specify a list of projects to restrict the client to. | |||
| Set the {config:option}`project-restricted:restricted` key to `true` and specify a list of projects to restrict the client to. | |||
There was a problem hiding this comment.
This doesn't refer to the restricted option for project, but it's a field in the trust certificate. So no link here.
doc/howto/projects_confine.md
Outdated
| @@ -40,7 +40,7 @@ To confine access for an existing certificate (either because the access restric | |||
|
|
|||
| lxc config trust edit <fingerprint> | |||
|
|
|||
| Make sure that `restricted` is set to `true` and specify the projects that the certificate should give access to under `projects`. | |||
| Make sure that {config:option}`project-restricted:restricted` is set to `true` and specify the projects that the certificate should give access to under `projects`. | |||
There was a problem hiding this comment.
Again, that's the field in the certificate, not the project config option.
doc/reference/projects.md
Outdated
| In the latter case, the limit usually applies to the {ref}`instance-options-limits` that are configured for each instance (either directly or via a profile), and not to the resources that are actually in use. | ||
|
|
||
| For example, if you set the project's `limits.memory` configuration to `50GiB`, the sum of the individual values of all `limits.memory` configuration keys defined on the project's instances will be kept under 50 GiB. | ||
| If you try to create an instance that would make the total sum of `limits.memory` configurations exceed 50 GiB, you will get an error. | ||
| For example, if you set the project's {config:option}`project-limits:limits.memory` configuration to `50GiB`, the sum of the individual values of all {config:option}`project-limits:limits.memory` configuration keys defined on the project's instances will be kept under 50 GiB. |
There was a problem hiding this comment.
Suggested change
| For example, if you set the project's {config:option}`project-limits:limits.memory` configuration to `50GiB`, the sum of the individual values of all {config:option}`project-limits:limits.memory` configuration keys defined on the project's instances will be kept under 50 GiB. | |
| For example, if you set the project's {config:option}`project-limits:limits.memory` configuration to `50GiB`, the sum of the individual values of all {config:option}`instance-resource-limits:limits.memory` configuration keys defined on the project's instances will be kept under 50 GiB. |
doc/reference/projects.md
Outdated
|
|
||
| Similarly, setting the project's `limits.cpu` configuration key to `100` means that the sum of individual `limits.cpu` values will be kept below 100. | ||
| Similarly, setting the project's {config:option}`project-limits:limits.cpu` configuration key to `100` means that the sum of individual {config:option}`project-limits:limits.cpu` values will be kept below 100. |
There was a problem hiding this comment.
Suggested change
| Similarly, setting the project's {config:option}`project-limits:limits.cpu` configuration key to `100` means that the sum of individual {config:option}`project-limits:limits.cpu` values will be kept below 100. | |
| Similarly, setting the project's {config:option}`project-limits:limits.cpu` configuration key to `100` means that the sum of individual {config:option}`instance-resource-limits:limits.cpu` values will be kept below 100. |
doc/reference/projects.md
Outdated
| `limits.processes` | integer | - | Maximum value for the sum of individual `limits.processes` configurations set on the instances of the project | ||
| `limits.virtual-machines` | integer | - | Maximum number of VMs that can be created in the project | ||
| - The {config:option}`project-limits:limits.cpu` configuration cannot be used if {ref}`instance-options-limits-cpu` is enabled. | ||
| This means that to use {config:option}`project-limits:limits.cpu` on a project, the {config:option}`project-limits:limits.cpu` configuration of each instance in the project must be set to a number of CPUs, not a set or a range of CPUs. |
There was a problem hiding this comment.
Suggested change
| This means that to use {config:option}`project-limits:limits.cpu` on a project, the {config:option}`project-limits:limits.cpu` configuration of each instance in the project must be set to a number of CPUs, not a set or a range of CPUs. | |
| This means that to use {config:option}`project-limits:limits.cpu` on a project, the {config:option}`instance-resource-limits:limits.cpu` configuration of each instance in the project must be set to a number of CPUs, not a set or a range of CPUs. |
lxd/api_project.go
Outdated
| // Only CPUs that are specified here can be used in the individual {config:option}`instance-resource-limits:limits.cpu` configurations set on the instances of the project. | ||
| // --- | ||
| // type: integer | ||
| // shortdesc: Which CPUs to use in the project |
There was a problem hiding this comment.
Suggested change
| // shortdesc: Which CPUs to use in the project | |
| // shortdesc: Maximum number of CPUs to use in the project |
lxd/api_project.go
Outdated
| // shortdesc: Maximum number of processes within the project | ||
| "limits.processes": validate.Optional(validate.IsUint32), | ||
| // lxdmeta:generate(entity=project, group=limits, key=limits.cpu) | ||
| // Only CPUs that are specified here can be used in the individual {config:option}`instance-resource-limits:limits.cpu` configurations set on the instances of the project. |
There was a problem hiding this comment.
Suggested change
| // Only CPUs that are specified here can be used in the individual {config:option}`instance-resource-limits:limits.cpu` configurations set on the instances of the project. | |
| // This value is the maximum value for the sum of the individual {config:option}`instance-resource-limits:limits.cpu` configurations set on the instances of the project. |
lxd/api_project.go
Outdated
| // shortdesc: Usage limit for the host's memory for the project | ||
| "limits.memory": validate.Optional(validate.IsSize), | ||
| // lxdmeta:generate(entity=project, group=limits, key=limits.processes) | ||
| // This value is the maximum value for the sum of individual {config:option}`instance-resource-limits:limits.processes` configurations set on the instances of the project. |
There was a problem hiding this comment.
Suggested change
| // This value is the maximum value for the sum of individual {config:option}`instance-resource-limits:limits.processes` configurations set on the instances of the project. | |
| // This value is the maximum value for the sum of the individual {config:option}`instance-resource-limits:limits.processes` configurations set on the instances of the project. |
Signed-off-by: Gabriel Mougard <gabriel.mougard@canonical.com>
Signed-off-by: Gabriel Mougard <gabriel.mougard@canonical.com>
Signed-off-by: Gabriel Mougard <gabriel.mougard@canonical.com>
Signed-off-by: Gabriel Mougard <gabriel.mougard@canonical.com>
gabrielmougard
force-pushed
the
feat/doc-project-config-options
branch
from
7eebf62
to
73c5e60
Compare
|
@ru-fu updated |
|
@gabrielmougard when you're ready for this to be reviewed and merge please mark as ready to review |
tomponline
approved these changes
Sep 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This requires this to be merged first
JIRA task : here