Skip to content
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

Closed
wants to merge 1 commit into from

Conversation

Bradamant3
Copy link
Contributor

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

Signed-off-by: JENNIFER RONDEAU <[email protected]>
## 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.
Copy link
Contributor

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

Copy link
Contributor Author

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:
Copy link
Contributor

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.

Copy link
Contributor Author

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
Copy link
Contributor

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?

Copy link
Contributor Author

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?

Copy link
Contributor

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.

Copy link
Contributor Author

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

@Bradamant3 Bradamant3 changed the title address a few doc issues [WIP] address a few doc issues Feb 7, 2018
@Bradamant3
Copy link
Contributor Author

Closing because most of these changes were made as part of other pull requests. Some issues remain outstanding, will be addressed in subsequent PR.

@Bradamant3 Bradamant3 closed this Feb 21, 2018
@Bradamant3 Bradamant3 deleted the change-namespace branch November 8, 2018 13:16
weshayutin added a commit to weshayutin/velero that referenced this pull request Oct 30, 2023
…konveyor-dev

kopia/repository/config/aws.go: Set session.Options profile from config
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants