-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
[WIP] address a few doc issues #303
Conversation
Signed-off-by: JENNIFER RONDEAU <[email protected]>
47c04dd
to
1a607b4
Compare
## Parameter Reference | ||
## Install in any namespace | ||
|
||
To install Ark in another namespace, you can specify the namespace in your `Config` YAML. That is, you can replace the value `heptio-ark` in the example with the appropriate namespace value. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not just the Config yaml. It's all of the required resources that are created by the example yaml files:
- service account
- cluster-admin cluster role binding for service account
- ark role
- role binding for service account
- ark config
- ark deployment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, this is all also not unrelated to issues #274 and #275, which will take more time. (but which I should be able to get into the release ... just not today). Right now there's no obvious place for any of this stuff, bc the example YAML files are just that, YAML only. Discuss in today's squad sync?
|
||
To install Ark in another namespace, you can specify the namespace in your `Config` YAML. That is, you can replace the value `heptio-ark` in the example with the appropriate namespace value. | ||
|
||
Or you can run: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is only for the CLI. This is complementary. If you install the ark server into the foo
namespace, you would likely want to run ark client config set namespace=foo
so that any time you run ark backup create
or any of the other CLI commands, you avoid needing to specify --namespace=foo
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At a minimum, will clarify. See also previous comment.
@@ -99,5 +100,15 @@ Both errors and warnings are structured in the same way: | |||
|
|||
* `Namespaces`: A map of namespaces to the list of issues related to the restore of their respective resources. | |||
|
|||
## Restoring a load balancer Service |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer to see this in a "Known Issues" section/page - wdyt?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes. that's my preference too, but I'm also used to putting known issues into a changelog/release notes. Is this sufficient?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This type of information isn't really appropriate for a changelog or release notes. It doesn't affect a single version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
got it. separate section/page it is
Closing because most of these changes were made as part of other pull requests. Some issues remain outstanding, will be addressed in subsequent PR. |
…konveyor-dev kopia/repository/config/aws.go: Set session.Options profile from config
This PR addresses #301 and provides one approach to #264.
It also makes a few small copyedits to
hooks.md
, which needs more attention for #245