Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-14656

[Doc] Distribute the CLI tool and Policy Generator as a container image

XMLWordPrintable

    • None

      1. - [x] Mandatory: Add the required version to the Fix version/s field.

      2. - [x] Mandatory: Choose the type of documentation change or review.

      • [x] We need to update to an existing topic
      • [x] (Maybe???) We need to add a new document to an existing section

      3. - [x] Mandatory: Source: https://github.com/stolostron/rhacm-docs

      • We will need to update the What's New docs for the Console: https://github.com/stolostron/rhacm-docs/blob/2.12_stage/release_notes/whats_new.adoc
        Command Line Interface (CLI) downloads are now available in the {ocp-short} console made available through the `acm-cli` container image. The available downloads in 2.12 are `PolicyGenerator` for generating policies with Kustomize from Kubernetes manifests, and `policytools` with a `template-resolver` subcommand for resolving templates locally and (Dev Preview) a `dryrun` subcommand for executing `ConfigurationPolicy` manifests locally.
        
        See link:../governance/policy_generator.adoc#policy-generator[Policy Generator] to learn more about the policy generator.
        See link:../governance/<page/section_for_cli>[Policy Command Line Interface] to learn more about the policy CLI.
        
      • We will also need to update the Console topic and describe that the ACM CLI can be downloaded for customers to use. I'm thinking perhaps a subheading of "Home", maybe something like:
        [#cli-downloads]
        === Command Line Interface Downloads
        
        You can access Command Line Interface (CLI) downloads by using the following steps:
        
        1. Click `?` in the top of the console.
        2. Click *Command Line Tools*.
        3. Scroll to the "Advanced Cluster Management" heading. Here you will find a list of CLIs available for {acm-short} specified with the operating system and architecture. Select the appropriate binary to download and use on your local system.
        
      • We will want to mention that the CLI can be downloaded from the console on policy generator page: the https://github.com/stolostron/rhacm-docs/blob/2.12_stage/governance/policy_generator.adoc
      • We will want a section to give an overview of the policytools CLI, maybe something like:
        == Policy Command Line Interface
        
        The `policytools` command line interface (CLI) enables users to execute policies locally to aide with creating and debugging policies. View the subcommands available for `policytools`:
        
        - `template-resolver`: Locally resolve templates inside of policy manifests.
        - `dryrun` (Dev Preview): Locally execute `ConfigurationPolicy` manifests.
        
        === Template resolver subcommand
        
        The `template-resolver` subcommand resolves managed cluster and hub cluster templates embedded in policies. The `template-resolver` reads from either a file or from standard input.
        
        In order to resolve a policy with hub cluster templates, you must provide the `--cluster-name` argument with the name of a managed cluster that has been imported into {acm-short} and you must provide the `--hub-kubeconfig` argument with the path to a kubeconfig that points to the hub cluster.
        
        === Dry run subcommand (Dev Preview)
        
        The `dryrun` subcommand executes `ConfigurationPolicy` manifests locally. `dryrun` will reconcile the input `ConfigurationPolicy` and returns the resulting compliance and difference between the policy and the objects on the cluster.
        

      4. - [x] Mandatory for GA content:

      • [x] Add steps, the diff, known issue, and/or other important
        conceptual information in the following space:
      • [x] *Add Required access level *(example, *Cluster
        Administrator*) for the user to complete the task:
      • [x] Add verification at the end of the task, how does the user
        verify success (a command to run or a result to see?)
        • acm-cli-downloads deployment is available in the namespace where the MultiClusterHub components are deployed.
        • acm-cli-downloads consoleCLIDownload, route, and service resources are available on the cluster environment.

      5. - [ ] Mandatory for bugs: What is the diff? Clearly define what the
      problem is, what the change is, and link to the current documentation. Only
      use this for a documentation bug.

              bswope@redhat.com Brandi Swope
              dbennett@redhat.com Disaiah Bennett
              Thuy Nguyen Thuy Nguyen
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: