nspcc-dev / neofs-dev-env

NeoFS local Development and Testing environment
https://fs.neo.org
GNU General Public License v3.0
9 stars 25 forks source link

[#172] Fix help #227

Closed masterSplinter01 closed 2 years ago

masterSplinter01 commented 2 years ago

Closes #172

Now it prints:

 make help
  Usage:

    make <target>

  Targets:

    clean                                Clean-up the environment
    down/add                             Stop environment
    down/basic                           Stop basic environment
    down/bootstrap                       Stop bootstrap services
    down                                 Stop environment
    env                                  Generate environment
    get                                  Get all services artifacts
    help                                 Show this help prompt
    hosts                                Create/update vendor/hosts file and display changes
    prepare.ir                           Deposit GAS from default wallet to NeoFS privnet contract 
    prepare.storage                      Add self-signed node certificate to trusted store
    pull                                 Pull all required Docker images
    restart.storage-clean                Restart storage nodes with clean volumes
    tick.epoch                           Tick new epoch in side chain
    up/basic                             Build up NeoFS
    up/bootstrap                         Start bootstrap services
    update.audit_fee                     Update audit fee per result in fixed 12 (make update.audit_fee val=100)
    update.basic_income_rate             Update basic income rate in fixed 12 (make update.basic_income_rate val=1000)
    update.container_alias_fee           Update container alias fee per alphabet node in fixed 12 (make update.container_alias_fee val=100)
    update.container_fee                 Update container fee per alphabet node in fixed 12 (make update.container_fee val=500)
    update.eigen_trust_alpha             Update alpha parameter of EigenTrust algorithm in 0 <= f <= 1.0 (make update.eigen_trust_alpha val=0.2)
    update.eigen_trust_iterations        Update amount of EigenTrust iterations (make update.eigen_trust_iterations val=2)
    update.epoch_duration                Update epoch duration in side chain blocks (make update.epoch_duration val=30)
    update.homomorphic_hashing_disable   Update homomorphic hashing disabled flag (make update.homomorphic_hashing_disable val=true)
    update.max_object_size               Update max object size in bytes (make update.max_object_size val=1000)
    update.system_dns                    Update system dns to resolve container names (make update.system_dns val=container)
    up                                   Start environment
    vendor/hosts                         Create or update vendor/hosts file

The following targets were excluded from help:

 get.adm           Download NeoFS ADM tool 
    get.chain         Download privnet chain dump with pre-deployed NeoFS contracts
    get.cli           Download NeoFS CLI 
    get.contracts     Download NeoFS Contracts
    get.ir            Get NeoFS IR artifacts (LOCODE database and NeoFS CLI)
    get.locode        Get NeoFS LOCODE database
    get.morph_chain   Download NeoFS Contracts and Adm tool to deploy environment
    get.nats          Create certs for NATS server and clients
    get.storage       Create new tls certs to NeoFS node
realloc commented 2 years ago

@masterSplinter01 Could you please submit a similar fix for all repos affected?

alexvanin commented 2 years ago

Can we include fixes from https://github.com/nspcc-dev/neofs-dev-env/issues/172 in this PR as well? And then close this issue.