Skip to content

A Rust library for handling Akton Resource Names (ARNs), providing tools for generating, parsing, and managing ARNs within Akton-based cloud-native solutions.

Notifications You must be signed in to change notification settings

GovCraft/akton-arn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

akton-arn

Overview

The akton-arn crate provides a Rust-based implementation for handling Akton Resource Names (Arns), enabling the generation, parsing, and management of Arns within the Akton framework. This crate is designed to support cloud-native Akton-based solutions by offering robust, type-safe, and efficient Arn management capabilities. The functionality includes constructing, parsing, validating, and manipulating Arns according to the specified hierarchical structure used within various services.

Akton Resource Name (Arn) System

What is Arn?

The Akton Resource Name (Arn) is a structured identifier used within the Akton framework to uniquely identify and manage hierarchical actors across different services and partitions. Arns are designed to reflect the hierarchical relationships of actors within the system, facilitating effective management, security, and operational oversight.

Arn Structure

An Arn is composed of several parts, each representing a specific aspect of the resource:

arn:partition:service:account-id:hierarchy/path

Components

  • Arn: Indicates that the string is an Akton Resource Name.
    • partition: Classifies the resource as internal or external (akton-internal, akton-external).
    • service: Specifies the service within Akton system that the actor belongs to.
    • account-id: Identifies the owner or account responsible for the actor.
    • hierarchy/path: Provides a path-like structure that shows the actor's position within the tree, reflecting parent-child relationships.

Examples

Corporate Hierarchy Actor

arn:akton-internal:hr:company123:root/departmentA/team1

This Arn identifies an actor representing Team 1, which is part of Department A under the HR service, managed by account company123.

IoT Device in a Network Topology

arn:akton-external:iot:vendor456:root/region1/building5/floor3/device42

This Arn points to Device 42 located on Floor 3 of Building 5 in Region 1, managed by IoT services for the vendor account vendor456.

Crate Features

Path Construction

When adding new actors to the system, construct their Arn by appending to the parent's Arn path, ensuring each actor’s Arn accurately reflects their position within the hierarchy.

Dynamic Tree Manipulation

If an actor is moved within the hierarchy, update their Arn—and potentially those of all descendants—to reflect the new path. This keeps the identification consistent and meaningful.

Resource Management

Use Arns for logging, access control, and management tools to monitor interactions, manage permissions, and track activities based on actors' hierarchical locations.

Conclusion

The akton-arn crate is an essential component of the Akton framework, providing a robust method for uniquely identifying and managing actors within a complex, hierarchical structure, supporting enhanced security, operational management, and clarity throughout the system.

For more information, visit Akton's Github.